@doist/comms-sdk 0.0.1 → 0.2.0

package/dist/types/clients/conversations-client.d.ts

@@ -0,0 +1,346 @@
+import { z } from 'zod';
+import { type Conversation, type StatusOk, type UnreadConversation } from '../types/entities.js';
+import type { AddConversationUserArgs, AddConversationUsersArgs, GetConversationsArgs, GetOrCreateConversationArgs, MuteConversationArgs, RemoveConversationUserArgs, RemoveConversationUsersArgs, UpdateConversationArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+export declare const ConversationListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    workspaceId: z.ZodNumber;
+    userIds: z.ZodArray<z.ZodNumber>;
+    messageCount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    lastObjIndex: z.ZodNumber;
+    snippet: z.ZodString;
+    snippetCreators: z.ZodArray<z.ZodNumber>;
+    lastActive: z.ZodDate;
+    mutedUntil: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    archived: z.ZodBoolean;
+    created: z.ZodDate;
+    creator: z.ZodNumber;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    private: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    lastMessage: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+        content: z.ZodString;
+        creator: z.ZodNumber;
+        conversationId: z.ZodString;
+        posted: z.ZodDate;
+        systemMessage: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodUnknown]>>>;
+        attachments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+            attachmentId: z.ZodString;
+            urlType: z.ZodString;
+            title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            underlyingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            duration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            uploadState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            video: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            videoType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        }, z.core.$loose>>>>;
+        reactions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodNumber>>>>;
+        actions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
+        objIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+        deleted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        workspaceId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    workspaceId: number;
+    userIds: number[];
+    lastObjIndex: number;
+    snippet: string;
+    snippetCreators: number[];
+    lastActive: Date;
+    archived: boolean;
+    created: Date;
+    creator: number;
+    messageCount?: number | null | undefined;
+    mutedUntil?: Date | null | undefined;
+    title?: string | null | undefined;
+    private?: boolean | null | undefined;
+    lastMessage?: {
+        id: string;
+        content: string;
+        creator: number;
+        conversationId: string;
+        posted: Date;
+        systemMessage?: unknown;
+        attachments?: {
+            [x: string]: unknown;
+            attachmentId: string;
+            urlType: string;
+            title?: string | null | undefined;
+            url?: string | null | undefined;
+            fileName?: string | null | undefined;
+            fileSize?: number | null | undefined;
+            underlyingType?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            imageWidth?: number | null | undefined;
+            imageHeight?: number | null | undefined;
+            duration?: string | null | undefined;
+            uploadState?: string | null | undefined;
+            video?: string | null | undefined;
+            videoType?: string | null | undefined;
+            videoAutoPlay?: boolean | null | undefined;
+        }[] | null | undefined;
+        reactions?: Record<string, number[]> | null | undefined;
+        actions?: unknown[] | null | undefined;
+        objIndex?: number | null | undefined;
+        lastEdited?: Date | null | undefined;
+        deleted?: boolean | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        directMentions?: number[] | null | undefined;
+        version?: number | null | undefined;
+        workspaceId?: number | null | undefined;
+    } | null | undefined;
+}, {
+    id: string;
+    workspaceId: number;
+    userIds: number[];
+    lastObjIndex: number;
+    snippet: string;
+    snippetCreators: number[];
+    lastActive: Date;
+    archived: boolean;
+    created: Date;
+    creator: number;
+    messageCount?: number | null | undefined;
+    mutedUntil?: Date | null | undefined;
+    title?: string | null | undefined;
+    private?: boolean | null | undefined;
+    lastMessage?: {
+        id: string;
+        content: string;
+        creator: number;
+        conversationId: string;
+        posted: Date;
+        systemMessage?: unknown;
+        attachments?: {
+            [x: string]: unknown;
+            attachmentId: string;
+            urlType: string;
+            title?: string | null | undefined;
+            url?: string | null | undefined;
+            fileName?: string | null | undefined;
+            fileSize?: number | null | undefined;
+            underlyingType?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            imageWidth?: number | null | undefined;
+            imageHeight?: number | null | undefined;
+            duration?: string | null | undefined;
+            uploadState?: string | null | undefined;
+            video?: string | null | undefined;
+            videoType?: string | null | undefined;
+            videoAutoPlay?: boolean | null | undefined;
+        }[] | null | undefined;
+        reactions?: Record<string, number[]> | null | undefined;
+        actions?: unknown[] | null | undefined;
+        objIndex?: number | null | undefined;
+        lastEdited?: Date | null | undefined;
+        deleted?: boolean | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        directMentions?: number[] | null | undefined;
+        version?: number | null | undefined;
+        workspaceId?: number | null | undefined;
+    } | null | undefined;
+}>>>;
+/**
+ * Client for `/api/v1/conversations/`. `getOrCreate` requires an `id` (the
+ * SDK auto-generates one for new conversations); the backend dedupes on
+ * `userIds`, so an existing conversation will be returned with its own
+ * already-assigned `id` and your generated one is silently dropped.
+ */
+export declare class ConversationsClient extends BaseClient {
+    /**
+     * Gets all conversations for a workspace.
+     *
+     * @param args - The arguments for getting conversations.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.archived - Optional flag to include archived conversations.
+     * @returns An array of conversation objects.
+     *
+     * @example
+     * ```typescript
+     * const conversations = await api.conversations.getConversations({ workspaceId: 123 })
+     * conversations.forEach(c => console.log(c.title))
+     * ```
+     */
+    getConversations(args: GetConversationsArgs): Promise<Conversation[]>;
+    /**
+     * Gets a single conversation object by id.
+     *
+     * @param id - The conversation ID.
+     * @returns The conversation object.
+     */
+    getConversation(id: string): Promise<Conversation>;
+    /**
+     * Gets an existing 1:1 / group conversation with `userIds`, or creates a
+     * new one. `id` is auto-generated if not supplied — on dedupe, the
+     * backend returns the existing conversation's `id` instead.
+     *
+     * @param args - The arguments for getting or creating a conversation.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userIds - Array of user IDs to include in the conversation.
+     * @returns The conversation object (existing or newly created).
+     *
+     * @example
+     * ```typescript
+     * const conversation = await api.conversations.getOrCreateConversation({
+     *   workspaceId: 123,
+     *   userIds: [101, 202, 303],
+     * })
+     * ```
+     */
+    getOrCreateConversation(args: GetOrCreateConversationArgs): Promise<Conversation>;
+    /**
+     * Updates a conversation's title.
+     *
+     * @param args - The arguments for updating a conversation.
+     * @param args.id - The conversation ID.
+     * @param args.title - The new title for the conversation.
+     * @param args.archived - Optional flag to archive/unarchive the conversation.
+     * @returns The updated conversation object.
+     *
+     * @example
+     * ```typescript
+     * const conversation = await api.conversations.updateConversation({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     *   title: 'New Title',
+     * })
+     * ```
+     */
+    updateConversation(args: UpdateConversationArgs): Promise<Conversation>;
+    /**
+     * Archives a conversation.
+     *
+     * @param id - The conversation ID.
+     * @returns The updated conversation object.
+     */
+    archiveConversation(id: string): Promise<Conversation>;
+    /**
+     * Unarchives a conversation.
+     *
+     * @param id - The conversation ID.
+     * @returns The updated conversation object.
+     */
+    unarchiveConversation(id: string): Promise<Conversation>;
+    /**
+     * Adds a user to a conversation.
+     *
+     * @param args - The arguments for adding a user.
+     * @param args.id - The conversation ID.
+     * @param args.userId - The user ID to add.
+     * @returns The updated conversation object.
+     */
+    addUser(args: AddConversationUserArgs): Promise<Conversation>;
+    /**
+     * Adds multiple users to a conversation.
+     *
+     * @param args - The arguments for adding users.
+     * @param args.id - The conversation ID.
+     * @param args.userIds - Array of user IDs to add.
+     * @returns The updated conversation object.
+     *
+     * @example
+     * ```typescript
+     * await api.conversations.addUsers({ id: '7YpL3oZ4kZ9vP7Q1tR2sX42', userIds: [101, 202] })
+     * ```
+     */
+    addUsers(args: AddConversationUsersArgs): Promise<Conversation>;
+    /**
+     * Removes a user from a conversation.
+     *
+     * @param args - The arguments for removing a user.
+     * @param args.id - The conversation ID.
+     * @param args.userId - The user ID to remove.
+     * @returns The updated conversation object.
+     */
+    removeUser(args: RemoveConversationUserArgs): Promise<Conversation>;
+    /**
+     * Removes multiple users from a conversation.
+     *
+     * @param args - The arguments for removing users.
+     * @param args.id - The conversation ID.
+     * @param args.userIds - Array of user IDs to remove.
+     * @returns The updated conversation object.
+     */
+    removeUsers(args: RemoveConversationUsersArgs): Promise<Conversation>;
+    /**
+     * Marks a conversation as read.
+     *
+     * @param args - The arguments for marking as read.
+     * @param args.id - The conversation ID.
+     * @param args.objIndex - Optional index of the message to mark as last read.
+     * @param args.messageId - Optional message ID to mark as last read.
+     */
+    markRead(args: {
+        id: string;
+        objIndex?: number;
+        messageId?: string;
+    }): Promise<StatusOk>;
+    /**
+     * Marks a conversation as unread.
+     *
+     * @param args - The arguments for marking as unread.
+     * @param args.id - The conversation ID.
+     * @param args.objIndex - Optional index of the message to mark as last unread.
+     * @param args.messageId - Optional message ID to mark as last unread.
+     */
+    markUnread(args: {
+        id: string;
+        objIndex?: number;
+        messageId?: string;
+    }): Promise<StatusOk>;
+    /**
+     * Returns unread conversations for a workspace, paired with the unread
+     * version counter.
+     *
+     * @param workspaceId - The workspace ID.
+     * @returns Object containing the array of unread conversation references and a version counter.
+     */
+    getUnread(workspaceId: number): Promise<{
+        data: UnreadConversation[];
+        version: number;
+    }>;
+    /**
+     * Clears all unread conversations for a workspace.
+     *
+     * @param workspaceId - The workspace ID.
+     */
+    clearUnread(workspaceId: number): Promise<StatusOk>;
+    /**
+     * Mutes a conversation for a specified number of minutes.
+     * The user will receive no notifications from this conversation during that period.
+     *
+     * @param args - The arguments for muting a conversation.
+     * @param args.id - The conversation ID.
+     * @param args.minutes - Number of minutes to mute the conversation.
+     * @returns The updated conversation object.
+     *
+     * @example
+     * ```typescript
+     * const conversation = await api.conversations.muteConversation({ id: '7YpL3oZ4kZ9vP7Q1tR2sX42', minutes: 30 })
+     * ```
+     */
+    muteConversation(args: MuteConversationArgs): Promise<Conversation>;
+    /**
+     * Unmutes a conversation.
+     *
+     * @param id - The conversation ID.
+     * @returns The updated conversation object.
+     */
+    unmuteConversation(id: string): Promise<Conversation>;
+    private simple;
+}

package/dist/types/clients/groups-client.d.ts

@@ -0,0 +1,148 @@
+import { z } from 'zod';
+import { type Group, type StatusOk } from '../types/entities.js';
+import type { AddGroupUserArgs, AddGroupUsersArgs, RemoveGroupUserArgs, RemoveGroupUsersArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+export declare const GroupListSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    workspaceId: z.ZodNumber;
+    userIds: z.ZodArray<z.ZodNumber>;
+    version: z.ZodNumber;
+}, z.core.$strip>>;
+/**
+ * Client for `/api/v1/groups/`. The broadcast markers `EVERYONE` /
+ * `EVERYONE_IN_THREAD` are NOT addressable through these endpoints — they
+ * only appear as members of `direct_group_mentions` / `groups` lists on
+ * thread/comment writes.
+ *
+ * `getone` / `update` / `remove` and the member-management ops all require
+ * `workspace_id` alongside the group `id`.
+ */
+export declare class GroupsClient extends BaseClient {
+    /**
+     * Gets all groups for a given workspace.
+     *
+     * @param workspaceId - The workspace ID.
+     * @returns An array of group objects.
+     *
+     * @example
+     * ```typescript
+     * const groups = await api.groups.getGroups(123)
+     * groups.forEach(g => console.log(g.name))
+     * ```
+     */
+    getGroups(workspaceId: number): Promise<Group[]>;
+    /**
+     * Gets a single group object by id. Requires `workspaceId`.
+     *
+     * @param args - The arguments for getting a group.
+     * @param args.id - The group ID.
+     * @param args.workspaceId - The workspace ID.
+     * @returns The group object.
+     */
+    getGroup(args: {
+        id: string;
+        workspaceId: number;
+    }): Promise<Group>;
+    /**
+     * Creates a new group. `id` is auto-generated if not supplied.
+     *
+     * @param args - The arguments for creating a group.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.name - The group name.
+     * @param args.id - Optional caller-supplied group ID (for optimistic-UI workflows).
+     * @param args.description - Optional group description.
+     * @param args.userIds - Optional array of user IDs to add to the group.
+     * @returns The created group object.
+     *
+     * @example
+     * ```typescript
+     * const group = await api.groups.createGroup({
+     *   workspaceId: 123,
+     *   name: 'Engineering Team',
+     *   userIds: [1, 2, 3],
+     * })
+     * ```
+     */
+    createGroup(args: {
+        workspaceId: number;
+        name: string;
+        id?: string;
+        description?: string;
+        userIds?: number[];
+    }): Promise<Group>;
+    /**
+     * Updates a group's properties. Requires `workspaceId`.
+     *
+     * @param args - The arguments for updating a group.
+     * @param args.id - The group ID.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.name - Optional new group name.
+     * @param args.description - Optional new group description.
+     * @returns The updated group object.
+     */
+    updateGroup(args: {
+        id: string;
+        workspaceId: number;
+        name?: string;
+        description?: string;
+    }): Promise<Group>;
+    /**
+     * Permanently deletes a group. Requires `workspaceId`.
+     *
+     * @param args - The arguments for deleting a group.
+     * @param args.id - The group ID.
+     * @param args.workspaceId - The workspace ID.
+     */
+    deleteGroup(args: {
+        id: string;
+        workspaceId: number;
+    }): Promise<StatusOk>;
+    /**
+     * Adds a user to a group.
+     *
+     * @param args - The arguments for adding a user.
+     * @param args.id - The group ID.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userId - The user ID to add.
+     */
+    addUser(args: AddGroupUserArgs): Promise<StatusOk>;
+    /**
+     * Adds multiple users to a group.
+     *
+     * @param args - The arguments for adding users.
+     * @param args.id - The group ID.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userIds - Array of user IDs to add.
+     *
+     * @example
+     * ```typescript
+     * await api.groups.addUsers({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX45',
+     *   workspaceId: 123,
+     *   userIds: [101, 202, 303],
+     * })
+     * ```
+     */
+    addUsers(args: AddGroupUsersArgs): Promise<StatusOk>;
+    /**
+     * Removes a user from a group.
+     *
+     * @param args - The arguments for removing a user.
+     * @param args.id - The group ID.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userId - The user ID to remove.
+     */
+    removeUser(args: RemoveGroupUserArgs): Promise<StatusOk>;
+    /**
+     * Removes multiple users from a group.
+     *
+     * @param args - The arguments for removing users.
+     * @param args.id - The group ID.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userIds - Array of user IDs to remove.
+     */
+    removeUsers(args: RemoveGroupUsersArgs): Promise<StatusOk>;
+    private simple;
+}

package/dist/types/clients/inbox-client.d.ts

@@ -0,0 +1,96 @@
+import { type InboxThread } from '../types/entities.js';
+import type { ArchiveAllArgs, GetInboxArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+/** Client for `/api/v1/inbox/`. */
+export declare class InboxClient extends BaseClient {
+    /**
+     * Gets inbox items (threads).
+     *
+     * @param args - The arguments for getting inbox.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.newerThan - Optional date to get items newer than.
+     * @param args.olderThan - Optional date to get items older than.
+     * @param args.limit - Optional limit on number of items returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @param args.archiveFilter - Optional filter: 'active' (default), 'archived', or 'all'.
+     * @returns Inbox threads.
+     *
+     * @example
+     * ```typescript
+     * const inbox = await api.inbox.getInbox({
+     *   workspaceId: 123,
+     *   newerThan: new Date('2024-01-01'),
+     * })
+     *
+     * // Include archived (done) items alongside active ones
+     * const allInbox = await api.inbox.getInbox({
+     *   workspaceId: 123,
+     *   archiveFilter: 'all',
+     * })
+     * ```
+     */
+    getInbox(args: GetInboxArgs): Promise<InboxThread[]>;
+    /**
+     * Gets unread count for inbox.
+     *
+     * @param workspaceId - The workspace ID.
+     * @returns The unread count.
+     *
+     * @example
+     * ```typescript
+     * const count = await api.inbox.getCount(123)
+     * console.log(`Unread items: ${count}`)
+     * ```
+     */
+    getCount(workspaceId: number): Promise<number>;
+    /**
+     * Archives a thread in the inbox.
+     *
+     * @param id - The thread ID.
+     *
+     * @example
+     * ```typescript
+     * await api.inbox.archiveThread('7YpL3oZ4kZ9vP7Q1tR2sX3z')
+     * ```
+     */
+    archiveThread(id: string): Promise<void>;
+    /**
+     * Unarchives a thread in the inbox.
+     *
+     * @param id - The thread ID.
+     *
+     * @example
+     * ```typescript
+     * await api.inbox.unarchiveThread('7YpL3oZ4kZ9vP7Q1tR2sX3z')
+     * ```
+     */
+    unarchiveThread(id: string): Promise<void>;
+    /**
+     * Marks all inbox items as read in a workspace.
+     *
+     * @param workspaceId - The workspace ID.
+     *
+     * @example
+     * ```typescript
+     * await api.inbox.markAllRead(123)
+     * ```
+     */
+    markAllRead(workspaceId: number): Promise<void>;
+    /**
+     * Archives all inbox items in a workspace.
+     *
+     * @param args - The arguments for archiving all.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.channelIds - Optional array of channel IDs to filter by.
+     * @param args.olderThan - Optional date to filter items older than.
+     *
+     * @example
+     * ```typescript
+     * await api.inbox.archiveAll({
+     *   workspaceId: 123,
+     *   olderThan: new Date('2024-01-01'),
+     * })
+     * ```
+     */
+    archiveAll(args: ArchiveAllArgs): Promise<void>;
+}

package/dist/types/clients/reactions-client.d.ts

@@ -0,0 +1,57 @@
+import type { ReactionObject } from '../types/entities.js';
+import type { AddReactionArgs, GetReactionsArgs, RemoveReactionArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Client for interacting with Comms reaction endpoints.
+ */
+export declare class ReactionsClient extends BaseClient {
+    /**
+     * Adds an emoji reaction to a thread, comment, or conversation message.
+     *
+     * @param args - The arguments for adding a reaction.
+     * @param args.threadId - Optional thread ID.
+     * @param args.commentId - Optional comment ID.
+     * @param args.messageId - Optional message ID (for conversation messages).
+     * @param args.reaction - The reaction emoji to add.
+     *
+     * @example
+     * ```typescript
+     * await api.reactions.add({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z', reaction: '👍' })
+     * ```
+     */
+    add(args: AddReactionArgs): Promise<void>;
+    /**
+     * Gets reactions for a thread, comment, or conversation message.
+     *
+     * Returns an object with emoji reactions as keys and arrays of user IDs as
+     * values, or null if no reactions.
+     *
+     * @param args - The arguments for getting reactions.
+     * @param args.threadId - Optional thread ID.
+     * @param args.commentId - Optional comment ID.
+     * @param args.messageId - Optional message ID (for conversation messages).
+     * @returns A reaction object with emoji reactions as keys and arrays of user IDs as values, or null if no reactions.
+     *
+     * @example
+     * ```typescript
+     * const reactions = await api.reactions.get({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z' })
+     * // Returns: { "👍": [101, 202, 303], "❤️": [101, 202] }
+     * ```
+     */
+    get(args: GetReactionsArgs): Promise<ReactionObject>;
+    /**
+     * Removes an emoji reaction from a thread, comment, or conversation message.
+     *
+     * @param args - The arguments for removing a reaction.
+     * @param args.threadId - Optional thread ID.
+     * @param args.commentId - Optional comment ID.
+     * @param args.messageId - Optional message ID (for conversation messages).
+     * @param args.reaction - The reaction emoji to remove.
+     *
+     * @example
+     * ```typescript
+     * await api.reactions.remove({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z', reaction: '👍' })
+     * ```
+     */
+    remove(args: RemoveReactionArgs): Promise<void>;
+}