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

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;
 }

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

@@ -1,20 +1,478 @@
+import { z } from 'zod';
 import { type InboxThread } from '../types/entities.js';
 import type { ArchiveAllArgs, GetInboxArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
+export declare const InboxThreadListSchema: 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;
+    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.ZodArray<z.ZodNumber>>>>;
+    recipients: 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]>>>;
+    isArchived: z.ZodBoolean;
+    inInbox: z.ZodBoolean;
+    isSaved: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    closed: z.ZodBoolean;
+    responders: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    lastComment: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        content: z.ZodString;
+        creator: z.ZodNumber;
+        threadId: z.ZodString;
+        workspaceId: z.ZodNumber;
+        conversationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        posted: z.ZodDate;
+        lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+        directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        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.ZodUnknown>>>;
+        objIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        creatorName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        channelId: z.ZodString;
+        recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        toEmails: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        deleted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        deletedBy: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        actions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
+    }, z.core.$strip>, z.ZodTransform<{
+        url: string;
+        id: string;
+        content: string;
+        creator: number;
+        threadId: string;
+        workspaceId: number;
+        posted: Date;
+        channelId: string;
+        conversationId?: string | null | undefined;
+        lastEdited?: Date | null | undefined;
+        directMentions?: number[] | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        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, unknown> | null | undefined;
+        objIndex?: number | null | undefined;
+        creatorName?: string | null | undefined;
+        recipients?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+        deleted?: boolean | null | undefined;
+        deletedBy?: number | null | undefined;
+        version?: number | null | undefined;
+        actions?: unknown[] | null | undefined;
+    }, {
+        id: string;
+        content: string;
+        creator: number;
+        threadId: string;
+        workspaceId: number;
+        posted: Date;
+        channelId: string;
+        conversationId?: string | null | undefined;
+        lastEdited?: Date | null | undefined;
+        directMentions?: number[] | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        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, unknown> | null | undefined;
+        objIndex?: number | null | undefined;
+        creatorName?: string | null | undefined;
+        recipients?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+        deleted?: boolean | null | undefined;
+        deletedBy?: number | null | undefined;
+        version?: number | null | undefined;
+        actions?: unknown[] | null | undefined;
+    }>>>>;
+    toEmails: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, 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;
+    inInbox: boolean;
+    closed: 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;
+    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, number[]> | null | undefined;
+    recipients?: number[] | null | undefined;
+    snippetMaskAvatarUrl?: string | null | undefined;
+    snippetMaskPoster?: string | null | undefined;
+    systemMessage?: unknown;
+    isSaved?: boolean | null | undefined;
+    responders?: number[] | null | undefined;
+    lastComment?: {
+        url: string;
+        id: string;
+        content: string;
+        creator: number;
+        threadId: string;
+        workspaceId: number;
+        posted: Date;
+        channelId: string;
+        conversationId?: string | null | undefined;
+        lastEdited?: Date | null | undefined;
+        directMentions?: number[] | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        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, unknown> | null | undefined;
+        objIndex?: number | null | undefined;
+        creatorName?: string | null | undefined;
+        recipients?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+        deleted?: boolean | null | undefined;
+        deletedBy?: number | null | undefined;
+        version?: number | null | undefined;
+        actions?: unknown[] | null | undefined;
+    } | null | undefined;
+    toEmails?: string[] | null | undefined;
+    version?: number | 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;
+    inInbox: boolean;
+    closed: 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;
+    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, number[]> | null | undefined;
+    recipients?: number[] | null | undefined;
+    snippetMaskAvatarUrl?: string | null | undefined;
+    snippetMaskPoster?: string | null | undefined;
+    systemMessage?: unknown;
+    isSaved?: boolean | null | undefined;
+    responders?: number[] | null | undefined;
+    lastComment?: {
+        url: string;
+        id: string;
+        content: string;
+        creator: number;
+        threadId: string;
+        workspaceId: number;
+        posted: Date;
+        channelId: string;
+        conversationId?: string | null | undefined;
+        lastEdited?: Date | null | undefined;
+        directMentions?: number[] | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        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, unknown> | null | undefined;
+        objIndex?: number | null | undefined;
+        creatorName?: string | null | undefined;
+        recipients?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+        deleted?: boolean | null | undefined;
+        deletedBy?: number | null | undefined;
+        version?: number | null | undefined;
+        actions?: unknown[] | null | undefined;
+    } | null | undefined;
+    toEmails?: string[] | null | undefined;
+    version?: number | null | undefined;
+}>>>;
 /** Client for `/api/v1/inbox/`. */
 export declare class InboxClient extends BaseClient {
+    private readonly linkBaseUrl;
+    private readonly inboxThreadSchema;
+    private readonly inboxThreadListSchema;
     /**
      * 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. */
+    /**
+     * 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. */
+    /**
+     * 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. */
+    /**
+     * 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. */
+    /**
+     * 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. */
+    /**
+     * 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

@@ -5,15 +5,53 @@ 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. */
+    /**
+     * 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. */
+    /**
+     * 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>;
 }