@doist/comms-sdk 0.0.1 → 0.2.0

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

@@ -0,0 +1,70 @@
+import { type SearchConversationResponse, type SearchResponse, type SearchThreadResponse } from '../types/entities.js';
+import type { SearchArgs, SearchConversationArgs, SearchThreadArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Client for interacting with Comms search endpoints.
+ */
+export declare class SearchClient extends BaseClient {
+    /**
+     * Searches across all threads and conversations in a workspace.
+     *
+     * @param args - The arguments for searching.
+     * @param args.query - The search query string. Optional when `mentionSelf: true` is set; required otherwise.
+     * @param args.workspaceId - The workspace ID to search in.
+     * @param args.channelIds - Optional array of channel IDs to filter by.
+     * @param args.authorIds - Optional array of author user IDs to filter by.
+     * @param args.mentionSelf - Optional flag to filter by mentions of the current user. When true, `query` may be omitted.
+     * @param args.dateFrom - Optional start date for filtering (YYYY-MM-DD).
+     * @param args.dateTo - Optional end date for filtering (YYYY-MM-DD).
+     * @param args.limit - Optional limit on number of results returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns Search results with pagination.
+     *
+     * @example
+     * ```typescript
+     * const results = await api.search.search({
+     *   query: 'important meeting',
+     *   workspaceId: 123,
+     * })
+     * ```
+     */
+    search(args: SearchArgs): Promise<SearchResponse>;
+    /**
+     * Searches within comments of a specific thread.
+     *
+     * @param args - The arguments for searching within a thread.
+     * @param args.query - The search query string.
+     * @param args.threadId - The thread ID to search in.
+     * @param args.limit - Optional limit on number of results returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns Comment IDs that match the search query.
+     *
+     * @example
+     * ```typescript
+     * const results = await api.search.searchThread({
+     *   query: 'deadline',
+     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     * })
+     * ```
+     */
+    searchThread(args: SearchThreadArgs): Promise<SearchThreadResponse>;
+    /**
+     * Searches within messages of a specific conversation.
+     *
+     * @param args - The arguments for searching within a conversation.
+     * @param args.query - The search query string.
+     * @param args.conversationId - The conversation ID to search in.
+     * @param args.limit - Optional limit on number of results returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns Message IDs that match the search query.
+     *
+     * @example
+     * ```typescript
+     * const results = await api.search.searchConversation({
+     *   query: 'budget',
+     *   conversationId: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     * })
+     * ```
+     */
+    searchConversation(args: SearchConversationArgs): Promise<SearchConversationResponse>;
+}

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

@@ -0,0 +1,536 @@
+import { z } from 'zod';
+import { type Comment, type StatusOk, type Thread, type UnreadThread } from '../types/entities.js';
+import type { CloseThreadArgs, CreateThreadArgs, GetThreadsArgs, MarkThreadReadArgs, MarkThreadUnreadArgs, MarkThreadUnreadForOthersArgs, MoveThreadToChannelArgs, MuteThreadArgs, ReopenThreadArgs, UpdateThreadArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+export declare const ThreadListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    content: z.ZodString;
+    creator: z.ZodNumber;
+    creatorName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelId: z.ZodString;
+    workspaceId: z.ZodNumber;
+    actions: z.ZodOptional<z.ZodNullable<z.ZodArray<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>>>>;
+    commentCount: z.ZodNumber;
+    closed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    lastObjIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    lastUpdated: z.ZodDate;
+    mutedUntil: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    participants: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    pinned: z.ZodOptional<z.ZodBoolean>;
+    pinnedTs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    posted: z.ZodDate;
+    reactions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    responders: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    snippet: z.ZodString;
+    snippetCreator: z.ZodNumber;
+    snippetMaskAvatarUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    snippetMaskPoster: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    systemMessage: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodUnknown]>>>;
+    toEmails: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    isArchived: z.ZodBoolean;
+    isSaved: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    inInbox: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    lastComment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        content: z.ZodString;
+        creator: z.ZodNumber;
+        creatorName: z.ZodString;
+        threadId: z.ZodString;
+        channelId: 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.ZodNumber;
+        lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+        deleted: z.ZodBoolean;
+        deletedBy: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        toEmails: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        version: z.ZodNumber;
+        workspaceId: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    title: string;
+    content: string;
+    creator: number;
+    channelId: string;
+    workspaceId: number;
+    commentCount: number;
+    lastUpdated: Date;
+    posted: Date;
+    snippet: string;
+    snippetCreator: number;
+    isArchived: boolean;
+    creatorName?: string | null | undefined;
+    actions?: unknown[] | null | undefined;
+    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;
+    closed?: boolean | null | undefined;
+    directGroupMentions?: string[] | null | undefined;
+    directMentions?: number[] | null | undefined;
+    groups?: string[] | null | undefined;
+    lastEdited?: Date | null | undefined;
+    lastObjIndex?: number | null | undefined;
+    mutedUntil?: Date | null | undefined;
+    participants?: number[] | null | undefined;
+    pinned?: boolean | undefined;
+    pinnedTs?: number | null | undefined;
+    reactions?: Record<string, unknown> | null | undefined;
+    recipients?: number[] | null | undefined;
+    responders?: number[] | null | undefined;
+    snippetMaskAvatarUrl?: string | null | undefined;
+    snippetMaskPoster?: string | null | undefined;
+    systemMessage?: unknown;
+    toEmails?: string[] | null | undefined;
+    isSaved?: boolean | null | undefined;
+    inInbox?: boolean | null | undefined;
+    lastComment?: {
+        id: string;
+        content: string;
+        creator: number;
+        creatorName: string;
+        threadId: string;
+        channelId: string;
+        posted: Date;
+        objIndex: number;
+        deleted: boolean;
+        version: number;
+        workspaceId: number;
+        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;
+        lastEdited?: Date | null | undefined;
+        deletedBy?: number | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        directMentions?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        recipients?: number[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+    } | null | undefined;
+}, {
+    id: string;
+    title: string;
+    content: string;
+    creator: number;
+    channelId: string;
+    workspaceId: number;
+    commentCount: number;
+    lastUpdated: Date;
+    posted: Date;
+    snippet: string;
+    snippetCreator: number;
+    isArchived: boolean;
+    creatorName?: string | null | undefined;
+    actions?: unknown[] | null | undefined;
+    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;
+    closed?: boolean | null | undefined;
+    directGroupMentions?: string[] | null | undefined;
+    directMentions?: number[] | null | undefined;
+    groups?: string[] | null | undefined;
+    lastEdited?: Date | null | undefined;
+    lastObjIndex?: number | null | undefined;
+    mutedUntil?: Date | null | undefined;
+    participants?: number[] | null | undefined;
+    pinned?: boolean | undefined;
+    pinnedTs?: number | null | undefined;
+    reactions?: Record<string, unknown> | null | undefined;
+    recipients?: number[] | null | undefined;
+    responders?: number[] | null | undefined;
+    snippetMaskAvatarUrl?: string | null | undefined;
+    snippetMaskPoster?: string | null | undefined;
+    systemMessage?: unknown;
+    toEmails?: string[] | null | undefined;
+    isSaved?: boolean | null | undefined;
+    inInbox?: boolean | null | undefined;
+    lastComment?: {
+        id: string;
+        content: string;
+        creator: number;
+        creatorName: string;
+        threadId: string;
+        channelId: string;
+        posted: Date;
+        objIndex: number;
+        deleted: boolean;
+        version: number;
+        workspaceId: number;
+        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;
+        lastEdited?: Date | null | undefined;
+        deletedBy?: number | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        directMentions?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        recipients?: number[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+    } | null | undefined;
+}>>>;
+/**
+ * Client for `/api/v1/threads/`. The SDK auto-generates the thread `id` on
+ * `createThread` when the caller doesn't supply one.
+ */
+export declare class ThreadsClient extends BaseClient {
+    /**
+     * Gets threads. At least one of `channelId` / `workspaceId` is required.
+     * `newerThan` / `olderThan` (`Date`) are converted to the
+     * `newer_than_ts` / `older_than_ts` epoch-second params on the wire.
+     *
+     * @param args - The arguments for getting threads.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.channelId - Optional channel ID to narrow to a single channel.
+     * @param args.archived - Optional flag to include archived threads.
+     * @param args.newerThan - Optional date to get threads newer than.
+     * @param args.olderThan - Optional date to get threads older than.
+     * @param args.limit - Optional limit on number of threads returned.
+     * @returns An array of thread objects.
+     *
+     * @example
+     * ```typescript
+     * const threads = await api.threads.getThreads({
+     *   workspaceId: 123,
+     *   channelId: '7YpL3oZ4kZ9vP7Q1tR2sX44',
+     * })
+     * threads.forEach(t => console.log(t.title))
+     * ```
+     */
+    getThreads(args: GetThreadsArgs): Promise<Thread[]>;
+    /**
+     * Gets a single thread object by id.
+     *
+     * @param id - The thread ID.
+     * @returns The thread object.
+     */
+    getThread(id: string): Promise<Thread>;
+    /**
+     * Creates a new thread in a channel. `id` is auto-generated if not supplied.
+     *
+     * @param args - The arguments for creating a thread.
+     * @param args.channelId - The channel ID.
+     * @param args.title - Optional thread title.
+     * @param args.content - The thread content.
+     * @param args.recipients - Optional array of user IDs to notify.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @returns The created thread object.
+     *
+     * @example
+     * ```typescript
+     * const thread = await api.threads.createThread({
+     *   channelId: '7YpL3oZ4kZ9vP7Q1tR2sX44',
+     *   title: 'New Feature Discussion',
+     *   content: 'Let\'s discuss the new feature...',
+     * })
+     * ```
+     */
+    createThread(args: CreateThreadArgs): Promise<Thread>;
+    /**
+     * Partial update of an existing thread.
+     *
+     * @param args - The arguments for updating a thread.
+     * @param args.id - The thread ID.
+     * @param args.title - Optional new thread title.
+     * @param args.content - Optional new thread content.
+     * @returns The updated thread object.
+     */
+    updateThread(args: UpdateThreadArgs): Promise<Thread>;
+    /**
+     * Permanently deletes a thread.
+     *
+     * @param id - The thread ID.
+     */
+    deleteThread(id: string): Promise<StatusOk>;
+    /**
+     * Saves a thread (formerly "star").
+     *
+     * @param id - The thread ID.
+     */
+    saveThread(id: string): Promise<StatusOk>;
+    /**
+     * Unsaves a thread (formerly "unstar").
+     *
+     * @param id - The thread ID.
+     */
+    unsaveThread(id: string): Promise<StatusOk>;
+    /**
+     * Pins a thread.
+     *
+     * @param id - The thread ID.
+     */
+    pinThread(id: string): Promise<StatusOk>;
+    /**
+     * Unpins a thread.
+     *
+     * @param id - The thread ID.
+     */
+    unpinThread(id: string): Promise<StatusOk>;
+    /**
+     * Moves a thread to another channel.
+     *
+     * @param args - The arguments for moving a thread.
+     * @param args.id - The thread ID.
+     * @param args.toChannel - The target channel ID.
+     * @returns The updated thread object.
+     */
+    moveToChannel(args: MoveThreadToChannelArgs): Promise<Thread>;
+    /**
+     * Marks a thread as read.
+     *
+     * @param args - The arguments for marking a thread as read.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last known read message.
+     */
+    markRead(args: MarkThreadReadArgs): Promise<StatusOk>;
+    /**
+     * Marks a thread as unread.
+     *
+     * @param args - The arguments for marking a thread as unread.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last unread message. Use -1 to mark the whole thread as unread.
+     */
+    markUnread(args: MarkThreadUnreadArgs): Promise<StatusOk>;
+    /**
+     * Marks a thread as unread for others. Useful to notify others about thread changes.
+     *
+     * @param args - The arguments for marking a thread as unread for others.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last unread message. Use -1 to mark the whole thread as unread.
+     */
+    markUnreadForOthers(args: MarkThreadUnreadForOthersArgs): Promise<StatusOk>;
+    /**
+     * Marks every thread in a workspace or channel as read. Exactly one of
+     * `workspaceId` / `channelId` should be set.
+     *
+     * @param args - Either workspaceId or channelId (one is required).
+     * @param args.workspaceId - The workspace ID.
+     * @param args.channelId - The channel ID.
+     *
+     * @example
+     * ```typescript
+     * // Mark all in workspace
+     * await api.threads.markAllRead({ workspaceId: 123 })
+     *
+     * // Mark all in channel
+     * await api.threads.markAllRead({ channelId: '7YpL3oZ4kZ9vP7Q1tR2sX44' })
+     * ```
+     */
+    markAllRead(args: {
+        workspaceId?: number;
+        channelId?: string;
+    }): Promise<StatusOk>;
+    /**
+     * Clears unread threads in a workspace.
+     *
+     * @param workspaceId - The workspace ID.
+     */
+    clearUnread(workspaceId: number): Promise<StatusOk>;
+    /**
+     * Returns unread threads for a workspace, paired with the unread version
+     * counter and (optionally) the inbox unread count.
+     *
+     * @param workspaceId - The workspace ID.
+     * @returns Object containing the array of unread thread references, a version counter, and optionally the inbox unread count.
+     */
+    getUnread(workspaceId: number): Promise<{
+        data: UnreadThread[];
+        version: number;
+        inboxUnread?: number | null;
+    }>;
+    /**
+     * Mutes a thread for a specified number of minutes.
+     * When muted, you will not get notified in your inbox about new comments.
+     *
+     * @param args - The arguments for muting a thread.
+     * @param args.id - The thread ID.
+     * @param args.minutes - Number of minutes to mute the thread.
+     * @returns The updated thread object.
+     *
+     * @example
+     * ```typescript
+     * const thread = await api.threads.muteThread({ id: '7YpL3oZ4kZ9vP7Q1tR2sX3z', minutes: 30 })
+     * ```
+     */
+    muteThread(args: MuteThreadArgs): Promise<Thread>;
+    /**
+     * Unmutes a thread.
+     * You will start to see notifications in your inbox again when new comments are added.
+     *
+     * @param id - The thread ID.
+     * @returns The updated thread object.
+     */
+    unmuteThread(id: string): Promise<Thread>;
+    /**
+     * Closes a thread by adding a comment with a close action.
+     *
+     * @param args - The arguments for closing a thread.
+     * @param args.id - The thread ID.
+     * @param args.content - The comment content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @param args.actions - Optional array of action objects.
+     * @param args.recipients - Optional array of user IDs to notify directly.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @param args.directMentions - Optional array of user IDs that were @-mentioned in
+     *   `content`.
+     * @param args.notifyAudience - Optional broader audience to notify in addition to
+     *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
+     *   `'thread'` notifies everyone who has interacted with the thread.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * const comment = await api.threads.closeThread({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   content: 'Closing this thread — resolved.',
+     * })
+     * ```
+     */
+    closeThread(args: CloseThreadArgs): Promise<Comment>;
+    /**
+     * Reopens a thread by adding a comment with a reopen action.
+     *
+     * @param args - The arguments for reopening a thread.
+     * @param args.id - The thread ID.
+     * @param args.content - The comment content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @param args.actions - Optional array of action objects.
+     * @param args.recipients - Optional array of user IDs to notify directly.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @param args.directMentions - Optional array of user IDs that were @-mentioned in
+     *   `content`.
+     * @param args.notifyAudience - Optional broader audience to notify in addition to
+     *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
+     *   `'thread'` notifies everyone who has interacted with the thread.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * const comment = await api.threads.reopenThread({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   content: 'Reopening — need further discussion.',
+     * })
+     * ```
+     */
+    reopenThread(args: ReopenThreadArgs): Promise<Comment>;
+    private addCommentWithAction;
+    private simple;
+}