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

package/dist/cjs/clients/groups-client.js

@@ -18,7 +18,18 @@ exports.GroupListSchema = zod_1.z.array(entities_1.GroupSchema);
  * `workspace_id` alongside the group `id`.
  */
 class GroupsClient extends base_client_1.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) {
         return (0, http_client_1.request)({
             httpMethod: 'GET',
@@ -29,31 +40,113 @@ class GroupsClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then((response) => exports.GroupListSchema.parse(response.data));
     }
-    /** 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) {
         return this.simple('GET', 'getone', { ...args }, entities_1.GroupSchema);
     }
-    /** 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) {
         return this.simple('POST', 'add', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, entities_1.GroupSchema);
     }
-    /** 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) {
         return this.simple('POST', 'update', { ...args }, entities_1.GroupSchema);
     }
-    /** 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) {
         return this.simple('POST', 'remove', { ...args }, entities_1.StatusOkSchema);
     }
+    /**
+     * 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) {
         return this.simple('POST', 'add_user', { ...args }, entities_1.StatusOkSchema);
     }
+    /**
+     * 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) {
         return this.simple('POST', 'add_users', { ...args }, entities_1.StatusOkSchema);
     }
+    /**
+     * 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) {
         return this.simple('POST', 'remove_user', { ...args }, entities_1.StatusOkSchema);
     }
+    /**
+     * 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) {
         return this.simple('POST', 'remove_users', { ...args }, entities_1.StatusOkSchema);
     }

package/dist/cjs/clients/inbox-client.js

@@ -9,15 +9,36 @@ const base_client_1 = require("./base-client");
 class InboxClient extends base_client_1.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) {
         const params = { workspace_id: args.workspaceId };
-        const newerThan = args.newerThan ?? args.since;
-        if (newerThan)
-            params.newer_than_ts = Math.floor(newerThan.getTime() / 1000);
-        const olderThan = args.olderThan ?? args.until;
-        if (olderThan)
-            params.older_than_ts = Math.floor(olderThan.getTime() / 1000);
+        if (args.newerThan)
+            params.newer_than_ts = Math.floor(args.newerThan.getTime() / 1000);
+        if (args.olderThan)
+            params.older_than_ts = Math.floor(args.olderThan.getTime() / 1000);
         if (args.limit)
             params.limit = args.limit;
         if (args.cursor)
@@ -33,7 +54,18 @@ class InboxClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data.map((thread) => entities_1.InboxThreadSchema.parse(thread)));
     }
-    /** 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) {
         return (0, http_client_1.request)({
             httpMethod: 'GET',
@@ -44,7 +76,16 @@ class InboxClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data.data);
     }
-    /** 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) {
         return (0, http_client_1.request)({
             httpMethod: 'POST',
@@ -55,7 +96,16 @@ class InboxClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** 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) {
         return (0, http_client_1.request)({
             httpMethod: 'POST',
@@ -66,7 +116,16 @@ class InboxClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** 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) {
         return (0, http_client_1.request)({
             httpMethod: 'POST',
@@ -77,14 +136,28 @@ class InboxClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** 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) {
         const params = { workspace_id: args.workspaceId };
         if (args.channelIds)
             params.channel_ids = args.channelIds;
-        const olderThan = args.olderThan ?? args.until;
-        if (olderThan)
-            params.older_than_ts = Math.floor(olderThan.getTime() / 1000);
+        if (args.olderThan)
+            params.older_than_ts = Math.floor(args.olderThan.getTime() / 1000);
         return (0, http_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.getBaseUri(),

package/dist/cjs/clients/reactions-client.js

@@ -17,7 +17,20 @@ function reactionTarget(args) {
  * Client for interacting with Comms reaction endpoints.
  */
 class ReactionsClient extends base_client_1.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) {
         return (0, http_client_1.request)({
             httpMethod: 'POST',
@@ -33,6 +46,18 @@ class ReactionsClient extends base_client_1.BaseClient {
      *
      * 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) {
         return (0, http_client_1.request)({
@@ -44,7 +69,20 @@ class ReactionsClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
-    /** 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) {
         return (0, http_client_1.request)({
             httpMethod: 'POST',

package/dist/cjs/clients/search-client.js

@@ -11,6 +11,26 @@ const base_client_1 = require("./base-client");
 class SearchClient extends base_client_1.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) {
         const params = { workspace_id: args.workspaceId };
@@ -44,6 +64,21 @@ class SearchClient extends base_client_1.BaseClient {
     }
     /**
      * 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) {
         const params = {
@@ -65,6 +100,21 @@ class SearchClient extends base_client_1.BaseClient {
     }
     /**
      * 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) {
         const params = {