featurebase-node 0.8.0 → 0.9.0

package/resources/support/conversations/tags.mjs

@@ -1,142 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../../core/resource.mjs";
-import { buildHeaders } from "../../../internal/headers.mjs";
-import { path } from "../../../internal/utils/path.mjs";
-/**
- * Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.
- */
-export class Tags extends APIResource {
-    /**
-     * Attaches a workspace tag to a conversation.
-     *
-     * This endpoint requires both the tag ID to attach and the `actingAdminId` of the
-     * admin on whose behalf the mutation is recorded.
-     *
-     * ### Path Parameters
-     *
-     * - `id` - The conversation ID (short ID)
-     *
-     * ### Request Body
-     *
-     * | Field           | Type   | Required | Description                                                              |
-     * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
-     * | `tagId`         | string | Yes      | The Featurebase tag ID to attach                                         |
-     * | `actingAdminId` | string | Yes      | The admin performing the mutation. Must be a member of the organization. |
-     *
-     * ### Behavior
-     *
-     * Featurebase resolves the latest taggable reply/message in the conversation and
-     * records the tag attachment against that part so audit metadata remains
-     * deterministic.
-     *
-     * ### Response
-     *
-     * Returns the affected tag plus attachment metadata such as `targetPartId`,
-     * `appliedAt`, and `appliedBy`.
-     *
-     * ### Example Request
-     *
-     * ```json
-     * {
-     *   "tagId": "67ec1234abcd5678ef901234",
-     *   "actingAdminId": "507f1f77bcf86cd799439011"
-     * }
-     * ```
-     *
-     * ### Version Availability
-     *
-     * This endpoint is only available in API version 2026-01-01.nova and newer.
-     *
-     * @example
-     * ```ts
-     * const attachedConversationTag =
-     *   await client.support.conversations.tags.attach('12345', {
-     *     actingAdminId: '507f1f77bcf86cd799439011',
-     *     tagId: '67ec1234abcd5678ef901234',
-     *   });
-     * ```
-     */
-    attach(id, params, options) {
-        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
-        return this._client.post(path `/v2/conversations/${id}/tags`, {
-            body,
-            ...options,
-            headers: buildHeaders([
-                {
-                    ...(featurebaseVersion?.toString() != null ?
-                        { 'Featurebase-Version': featurebaseVersion?.toString() }
-                        : undefined),
-                },
-                options?.headers,
-            ]),
-        });
-    }
-    /**
-     * Removes a workspace tag from a conversation.
-     *
-     * This endpoint requires the `actingAdminId` of the admin on whose behalf the
-     * mutation is recorded.
-     *
-     * ### Path Parameters
-     *
-     * - `id` - The conversation ID (short ID)
-     * - `tagId` - The Featurebase tag ID to remove
-     *
-     * ### Request Body
-     *
-     * | Field           | Type   | Required | Description                                                              |
-     * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
-     * | `actingAdminId` | string | Yes      | The admin performing the mutation. Must be a member of the organization. |
-     *
-     * ### Behavior
-     *
-     * Featurebase resolves the latest taggable reply/message in the conversation and
-     * records the tag removal against that part so audit metadata remains
-     * deterministic.
-     *
-     * ### Response
-     *
-     * Returns the affected tag payload with the most relevant attachment metadata
-     * available for that relationship.
-     *
-     * ### Example Request
-     *
-     * ```json
-     * {
-     *   "actingAdminId": "507f1f77bcf86cd799439011"
-     * }
-     * ```
-     *
-     * ### Version Availability
-     *
-     * This endpoint is only available in API version 2026-01-01.nova and newer.
-     *
-     * @example
-     * ```ts
-     * const attachedConversationTag =
-     *   await client.support.conversations.tags.detach(
-     *     '67ec1234abcd5678ef901234',
-     *     {
-     *       id: '12345',
-     *       actingAdminId: '507f1f77bcf86cd799439011',
-     *     },
-     *   );
-     * ```
-     */
-    detach(tagID, params, options) {
-        const { id, 'Featurebase-Version': featurebaseVersion, ...body } = params;
-        return this._client.delete(path `/v2/conversations/${id}/tags/${tagID}`, {
-            body,
-            ...options,
-            headers: buildHeaders([
-                {
-                    ...(featurebaseVersion?.toString() != null ?
-                        { 'Featurebase-Version': featurebaseVersion?.toString() }
-                        : undefined),
-                },
-                options?.headers,
-            ]),
-        });
-    }
-}
-//# sourceMappingURL=tags.mjs.map

package/resources/support/conversations/tags.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"tags.mjs","sourceRoot":"","sources":["../../../src/resources/support/conversations/tags.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,MAAM,CAAC,EAAU,EAAE,MAAuB,EAAE,OAAwB;QAClE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,OAAO,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,MAAM,CACJ,KAAa,EACb,MAAuB,EACvB,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,SAAS,KAAK,EAAE,EAAE;YACtE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -1,260 +0,0 @@
-// 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';
-import { path } from '../../../internal/utils/path';
-
-/**
- * Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.
- */
-export class Tags extends APIResource {
-  /**
-   * Attaches a workspace tag to a conversation.
-   *
-   * This endpoint requires both the tag ID to attach and the `actingAdminId` of the
-   * admin on whose behalf the mutation is recorded.
-   *
-   * ### Path Parameters
-   *
-   * - `id` - The conversation ID (short ID)
-   *
-   * ### Request Body
-   *
-   * | Field           | Type   | Required | Description                                                              |
-   * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
-   * | `tagId`         | string | Yes      | The Featurebase tag ID to attach                                         |
-   * | `actingAdminId` | string | Yes      | The admin performing the mutation. Must be a member of the organization. |
-   *
-   * ### Behavior
-   *
-   * Featurebase resolves the latest taggable reply/message in the conversation and
-   * records the tag attachment against that part so audit metadata remains
-   * deterministic.
-   *
-   * ### Response
-   *
-   * Returns the affected tag plus attachment metadata such as `targetPartId`,
-   * `appliedAt`, and `appliedBy`.
-   *
-   * ### Example Request
-   *
-   * ```json
-   * {
-   *   "tagId": "67ec1234abcd5678ef901234",
-   *   "actingAdminId": "507f1f77bcf86cd799439011"
-   * }
-   * ```
-   *
-   * ### Version Availability
-   *
-   * This endpoint is only available in API version 2026-01-01.nova and newer.
-   *
-   * @example
-   * ```ts
-   * const attachedConversationTag =
-   *   await client.support.conversations.tags.attach('12345', {
-   *     actingAdminId: '507f1f77bcf86cd799439011',
-   *     tagId: '67ec1234abcd5678ef901234',
-   *   });
-   * ```
-   */
-  attach(id: string, params: TagAttachParams, options?: RequestOptions): APIPromise<AttachedConversationTag> {
-    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
-    return this._client.post(path`/v2/conversations/${id}/tags`, {
-      body,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
-  /**
-   * Removes a workspace tag from a conversation.
-   *
-   * This endpoint requires the `actingAdminId` of the admin on whose behalf the
-   * mutation is recorded.
-   *
-   * ### Path Parameters
-   *
-   * - `id` - The conversation ID (short ID)
-   * - `tagId` - The Featurebase tag ID to remove
-   *
-   * ### Request Body
-   *
-   * | Field           | Type   | Required | Description                                                              |
-   * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
-   * | `actingAdminId` | string | Yes      | The admin performing the mutation. Must be a member of the organization. |
-   *
-   * ### Behavior
-   *
-   * Featurebase resolves the latest taggable reply/message in the conversation and
-   * records the tag removal against that part so audit metadata remains
-   * deterministic.
-   *
-   * ### Response
-   *
-   * Returns the affected tag payload with the most relevant attachment metadata
-   * available for that relationship.
-   *
-   * ### Example Request
-   *
-   * ```json
-   * {
-   *   "actingAdminId": "507f1f77bcf86cd799439011"
-   * }
-   * ```
-   *
-   * ### Version Availability
-   *
-   * This endpoint is only available in API version 2026-01-01.nova and newer.
-   *
-   * @example
-   * ```ts
-   * const attachedConversationTag =
-   *   await client.support.conversations.tags.detach(
-   *     '67ec1234abcd5678ef901234',
-   *     {
-   *       id: '12345',
-   *       actingAdminId: '507f1f77bcf86cd799439011',
-   *     },
-   *   );
-   * ```
-   */
-  detach(
-    tagID: string,
-    params: TagDetachParams,
-    options?: RequestOptions,
-  ): APIPromise<AttachedConversationTag> {
-    const { id, 'Featurebase-Version': featurebaseVersion, ...body } = params;
-    return this._client.delete(path`/v2/conversations/${id}/tags/${tagID}`, {
-      body,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-}
-
-export interface AttachedConversationTag {
-  /**
-   * Unique tag identifier
-   */
-  id: string;
-
-  /**
-   * Current tag name
-   */
-  name: string;
-
-  /**
-   * Object type identifier for a tag
-   */
-  type: 'tag';
-
-  /**
-   * ISO timestamp when the tag was applied
-   */
-  appliedAt?: string | null;
-
-  /**
-   * Actor that applied the tag
-   */
-  appliedBy?: ConversationTagMutationActor | null;
-
-  /**
-   * ISO timestamp when the tag was removed, if applicable
-   */
-  removedAt?: string | null;
-
-  /**
-   * Actor that applied the tag
-   */
-  removedBy?: ConversationTagMutationActor | null;
-
-  /**
-   * Reply/message ID used as the deterministic attachment target for this
-   * conversation tag mutation.
-   */
-  targetPartId?: string | null;
-}
-
-/**
- * Actor that applied the tag
- */
-export interface ConversationTagMutationActor {
-  /**
-   * Actor that caused the tag mutation
-   */
-  type: 'admin' | 'customer' | 'lead' | 'bot' | 'integration' | 'system' | 'workflow';
-
-  /**
-   * Actor identifier when available
-   */
-  id?: string | null;
-
-  /**
-   * Actor display name when available
-   */
-  name?: string | null;
-}
-
-export interface TagAttachParams {
-  /**
-   * Body param: Required admin ID performing this tag attachment. Must be a member
-   * of the organization so the mutation can be attributed to a real admin actor.
-   */
-  actingAdminId: string;
-
-  /**
-   * Body param: The Featurebase tag ID to attach to the conversation.
-   */
-  tagId: string;
-
-  /**
-   * Header param: API version for this request. Defaults to your organization's
-   * configured API version if not specified.
-   */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
-}
-
-export interface TagDetachParams {
-  /**
-   * Path param: Conversation ID (short ID)
-   */
-  id: string;
-
-  /**
-   * Body param: Required admin ID performing this tag removal. Must be a member of
-   * the organization so the mutation can be attributed to a real admin actor.
-   */
-  actingAdminId: string;
-
-  /**
-   * Header param: API version for this request. Defaults to your organization's
-   * configured API version if not specified.
-   */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
-}
-
-export declare namespace Tags {
-  export {
-    type AttachedConversationTag as AttachedConversationTag,
-    type ConversationTagMutationActor as ConversationTagMutationActor,
-    type TagAttachParams as TagAttachParams,
-    type TagDetachParams as TagDetachParams,
-  };
-}