@doist/comms-sdk 0.1.0-alpha.1 → 0.2.0

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

@@ -64,28 +64,145 @@ export declare const ChannelListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
  * to keep an optimistic-UI ID stable through the round-trip.
  */
 export declare class ChannelsClient extends BaseClient {
-    /** Lists channels in a workspace. */
+    /**
+     * Gets all channels for a given workspace.
+     *
+     * @param args - The arguments for getting channels.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.archived - Optional flag to include archived channels.
+     * @returns An array of channel objects.
+     *
+     * @example
+     * ```typescript
+     * const channels = await api.channels.getChannels({ workspaceId: 123 })
+     * channels.forEach(ch => console.log(ch.name))
+     * ```
+     */
     getChannels(args: GetChannelsArgs): Promise<Channel[]>;
-    /** Fetches a single channel by ID. */
+    /**
+     * Gets a single channel object by id.
+     *
+     * @param id - The channel ID.
+     * @returns The channel object.
+     */
     getChannel(id: string): Promise<Channel>;
-    /** Creates a new channel. `id` is auto-generated if not supplied. */
+    /**
+     * Creates a new channel. `id` is auto-generated if not supplied — pass your
+     * own `id` to keep an optimistic-UI ID stable through the round-trip.
+     *
+     * @param args - The arguments for creating a channel.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.name - The channel name.
+     * @param args.description - Optional channel description.
+     * @param args.color - Optional channel color.
+     * @param args.userIds - Optional array of user IDs to add to the channel.
+     * @param args.public - Optional flag to make the channel public.
+     * @returns The created channel object.
+     *
+     * @example
+     * ```typescript
+     * const channel = await api.channels.createChannel({
+     *   workspaceId: 123,
+     *   name: 'Engineering',
+     *   description: 'Engineering team channel',
+     * })
+     * ```
+     */
     createChannel(args: CreateChannelArgs): Promise<Channel>;
-    /** Partial update of an existing channel. */
+    /**
+     * Partial update of an existing channel.
+     *
+     * @param args - The arguments for updating a channel.
+     * @param args.id - The channel ID.
+     * @param args.name - Optional new channel name.
+     * @param args.description - Optional new channel description.
+     * @param args.color - Optional new channel color.
+     * @param args.public - Optional flag to change channel visibility.
+     * @returns The updated channel object.
+     */
     updateChannel(args: UpdateChannelArgs): Promise<Channel>;
-    /** Updates the channel's view filter (`only_open` / `all` / `only_closed`). */
+    /**
+     * Updates the channel's view filter (`only_open` / `all` / `only_closed`).
+     *
+     * @param args - The arguments for updating the channel filter.
+     * @param args.id - The channel ID.
+     * @param args.filterClosed - The new filter value.
+     */
     updateFilters(args: {
         id: string;
         filterClosed: 'only_open' | 'all' | 'only_closed';
     }): Promise<StatusOk>;
-    /** Permanently deletes a channel. */
+    /**
+     * Permanently deletes a channel.
+     *
+     * @param id - The channel ID.
+     */
     deleteChannel(id: string): Promise<StatusOk>;
+    /**
+     * Archives a channel.
+     *
+     * @param id - The channel ID.
+     */
     archiveChannel(id: string): Promise<StatusOk>;
+    /**
+     * Unarchives a channel.
+     *
+     * @param id - The channel ID.
+     */
     unarchiveChannel(id: string): Promise<StatusOk>;
+    /**
+     * Favorites a channel.
+     *
+     * @param id - The channel ID.
+     */
     favoriteChannel(id: string): Promise<StatusOk>;
+    /**
+     * Unfavorites a channel.
+     *
+     * @param id - The channel ID.
+     */
     unfavoriteChannel(id: string): Promise<StatusOk>;
+    /**
+     * Adds a user to a channel.
+     *
+     * @param args - The arguments for adding a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to add.
+     *
+     * @example
+     * ```typescript
+     * await api.channels.addUser({ id: '7YpL3oZ4kZ9vP7Q1tR2sX44', userId: 101 })
+     * ```
+     */
     addUser(args: AddChannelUserArgs): Promise<Channel>;
+    /**
+     * Adds multiple users to a channel.
+     *
+     * @param args - The arguments for adding users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to add.
+     *
+     * @example
+     * ```typescript
+     * await api.channels.addUsers({ id: '7YpL3oZ4kZ9vP7Q1tR2sX44', userIds: [101, 202] })
+     * ```
+     */
     addUsers(args: AddChannelUsersArgs): Promise<Channel>;
+    /**
+     * Removes a user from a channel.
+     *
+     * @param args - The arguments for removing a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to remove.
+     */
     removeUser(args: RemoveChannelUserArgs): Promise<Channel>;
+    /**
+     * Removes multiple users from a channel.
+     *
+     * @param args - The arguments for removing users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to remove.
+     */
     removeUsers(args: RemoveChannelUsersArgs): Promise<Channel>;
     private simple;
 }

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

@@ -135,23 +135,90 @@ export declare const CommentListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
  */
 export declare class CommentsClient extends BaseClient {
     /**
-     * Lists comments in a thread. `newerThan` / `olderThan` (`Date`) are
+     * Gets all comments for a thread. `newerThan` / `olderThan` (`Date`) are
      * converted to `newer_than_ts` / `older_than_ts` epoch seconds on the
      * wire.
+     *
+     * @param args - The arguments for getting comments.
+     * @param args.threadId - The thread ID.
+     * @param args.newerThan - Optional date to get comments newer than.
+     * @param args.olderThan - Optional date to get comments older than.
+     * @param args.limit - Optional limit on number of comments returned.
+     * @returns An array of comment objects.
+     *
+     * @example
+     * ```typescript
+     * const comments = await api.comments.getComments({
+     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   newerThan: new Date('2024-01-01'),
+     * })
+     * comments.forEach(c => console.log(c.content))
+     * ```
      */
     getComments(args: GetCommentsArgs): Promise<Comment[]>;
-    /** Fetches a single comment by ID. The API wraps it in `{comment: ...}`. */
+    /**
+     * Gets a single comment object by id. The API wraps it in `{comment: ...}`.
+     *
+     * @param id - The comment ID.
+     * @returns The comment object.
+     */
     getComment(id: string): Promise<Comment>;
     /**
-     * Creates a new comment. `id` is auto-generated if not supplied.
+     * Creates a new comment on a thread. `id` is auto-generated if not supplied.
+     *
+     * @param args - The arguments for creating a comment.
+     * @param args.threadId - The thread ID.
+     * @param args.content - The comment content.
+     * @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.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * // Notify everyone who has interacted with the thread, plus two extra users.
+     * const comment = await api.comments.createComment({
+     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   content: 'Great idea! Let\'s proceed.',
+     *   notifyAudience: 'thread',
+     *   recipients: [101, 202],
+     * })
+     * ```
      */
     createComment(args: CreateCommentArgs): Promise<Comment>;
-    /** Updates a comment. */
+    /**
+     * Updates a comment's properties.
+     *
+     * @param args - The arguments for updating a comment.
+     * @param args.id - The comment ID.
+     * @param args.content - The new comment content.
+     * @returns The updated comment object.
+     */
     updateComment(args: UpdateCommentArgs): Promise<Comment>;
-    /** Permanently deletes a comment. */
+    /**
+     * Permanently deletes a comment.
+     *
+     * @param id - The comment ID.
+     */
     deleteComment(id: string): Promise<StatusOk>;
     /**
-     * Marks the user's read position in a thread. Comment IDs are strings.
+     * Marks the user's read position in a thread. Used to track where the user has read up to,
+     * so clients can scroll to this position and show a visual indicator (blue line).
+     * Comment IDs are strings.
+     *
+     * @param args - The arguments for marking read position.
+     * @param args.threadId - The thread ID.
+     * @param args.commentId - The comment ID to mark as the last read position.
+     *
+     * @example
+     * ```typescript
+     * await api.comments.markPosition({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z', commentId: '7YpL3oZ4kZ9vP7Q1tR2sX41' })
+     * ```
      */
     markPosition(args: MarkCommentPositionArgs): Promise<StatusOk>;
 }

package/dist/types/clients/conversation-messages-client.d.ts

@@ -113,15 +113,86 @@ export declare const ConversationMessageListSchema: z.ZodArray<z.ZodPipe<z.ZodOb
  * message `id` on `createMessage` when the caller doesn't supply one.
  */
 export declare class ConversationMessagesClient extends BaseClient {
-    /** Lists messages in a conversation. */
+    /**
+     * Gets all messages in a conversation.
+     *
+     * @param args - The arguments for getting messages.
+     * @param args.conversationId - The conversation ID.
+     * @param args.newerThan - Optional date to get messages newer than.
+     * @param args.olderThan - Optional date to get messages older than.
+     * @param args.limit - Optional limit on number of messages returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns An array of message objects.
+     *
+     * @example
+     * ```typescript
+     * const messages = await api.conversationMessages.getMessages({
+     *   conversationId: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     *   newerThan: new Date('2024-01-01'),
+     * })
+     * ```
+     */
     getMessages(args: GetConversationMessagesArgs): Promise<ConversationMessage[]>;
-    /** Fetches a single message by ID. */
+    /**
+     * Gets a single conversation message by id.
+     *
+     * @param id - The message ID.
+     * @returns The conversation message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.getMessage('7YpL3oZ4kZ9vP7Q1tR2sX43')
+     * ```
+     */
     getMessage(id: string): Promise<ConversationMessage>;
-    /** Creates a new message. `id` is auto-generated if not supplied. */
+    /**
+     * Creates a new message in a conversation. `id` is auto-generated if not
+     * supplied.
+     *
+     * @param args - The arguments for creating a message.
+     * @param args.conversationId - The conversation ID.
+     * @param args.content - The message content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @param args.actions - Optional array of action objects.
+     * @returns The created message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.createMessage({
+     *   conversationId: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     *   content: 'Thanks for the update!',
+     * })
+     * ```
+     */
     createMessage(args: CreateConversationMessageArgs): Promise<ConversationMessage>;
-    /** Updates a message. */
+    /**
+     * Updates a conversation message.
+     *
+     * @param args - The arguments for updating a message.
+     * @param args.id - The message ID.
+     * @param args.content - The new message content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @returns The updated message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.updateMessage({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX43',
+     *   content: 'Updated message content',
+     * })
+     * ```
+     */
     updateMessage(args: UpdateConversationMessageArgs): Promise<ConversationMessage>;
-    /** Permanently deletes a message. */
+    /**
+     * Permanently deletes a conversation message.
+     *
+     * @param id - The message ID.
+     *
+     * @example
+     * ```typescript
+     * await api.conversationMessages.deleteMessage('7YpL3oZ4kZ9vP7Q1tR2sX43')
+     * ```
+     */
     deleteMessage(id: string): Promise<StatusOk>;
     private simple;
 }

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

@@ -163,29 +163,141 @@ export declare const ConversationListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
  * already-assigned `id` and your generated one is silently dropped.
  */
 export declare class ConversationsClient extends BaseClient {
-    /** Lists conversations in a workspace. */
+    /**
+     * 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[]>;
-    /** Fetches a single conversation by ID. */
+    /**
+     * 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. */
+    /**
+     * 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;
@@ -194,13 +306,41 @@ export declare class ConversationsClient extends BaseClient {
     /**
      * 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

@@ -20,14 +20,51 @@ export declare const GroupListSchema: z.ZodArray<z.ZodObject<{
  * `workspace_id` alongside the group `id`.
  */
 export declare class GroupsClient extends BaseClient {
-    /** Lists groups in a workspace. */
+    /**
+     * 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[]>;
-    /** Fetches a single group by ID (requires `workspaceId`). */
+    /**
+     * 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. */
+    /**
+     * 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;
@@ -35,21 +72,77 @@ export declare class GroupsClient extends BaseClient {
         description?: string;
         userIds?: number[];
     }): Promise<Group>;
-    /** Updates a group. Requires `workspaceId`. */
+    /**
+     * 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`. */
+    /**
+     * 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;
 }