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

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

@@ -20,19 +20,40 @@ const GetUnreadResponseSchema = zod_1.z.object({
  */
 class ThreadsClient extends base_client_1.BaseClient {
     /**
-     * Lists threads. At least one of `channelId` / `workspaceId` is required.
+     * 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) {
-        const { newerThan, olderThan, newer_than_ts, older_than_ts, ...rest } = args;
-        const resolvedNewerThan = newerThan ? Math.floor(newerThan.getTime() / 1000) : newer_than_ts;
-        const resolvedOlderThan = olderThan ? Math.floor(olderThan.getTime() / 1000) : older_than_ts;
-        const params = {
-            ...rest,
-            ...(resolvedNewerThan != null ? { newer_than_ts: resolvedNewerThan } : {}),
-            ...(resolvedOlderThan != null ? { older_than_ts: resolvedOlderThan } : {}),
-        };
+        const params = { workspaceId: args.workspaceId };
+        if (args.channelId != null)
+            params.channelId = args.channelId;
+        if (args.archived != null)
+            params.archived = args.archived;
+        if (args.limit != null)
+            params.limit = args.limit;
+        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);
         return (0, http_client_1.request)({
             httpMethod: 'GET',
             baseUri: this.getBaseUri(),
@@ -42,52 +63,147 @@ class ThreadsClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then((response) => exports.ThreadListSchema.parse(response.data));
     }
-    /** Fetches a single thread by ID. */
+    /**
+     * Gets a single thread object by id.
+     *
+     * @param id - The thread ID.
+     * @returns The thread object.
+     */
     getThread(id) {
         return this.simple('GET', 'getone', { id }, entities_1.ThreadSchema);
     }
-    /** Creates a new thread. `id` is auto-generated if not supplied. */
+    /**
+     * 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) {
         return this.simple('POST', 'add', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, entities_1.ThreadSchema);
     }
-    /** Partial update of an existing 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) {
         return this.simple('POST', 'update', { ...args }, entities_1.ThreadSchema);
     }
-    /** Permanently deletes a thread. */
+    /**
+     * Permanently deletes a thread.
+     *
+     * @param id - The thread ID.
+     */
     deleteThread(id) {
         return this.simple('POST', 'remove', { id }, entities_1.StatusOkSchema);
     }
-    /** Saves a thread (formerly "star"). */
+    /**
+     * Saves a thread (formerly "star").
+     *
+     * @param id - The thread ID.
+     */
     saveThread(id) {
         return this.simple('GET', 'save', { id }, entities_1.StatusOkSchema);
     }
-    /** Unsaves a thread (formerly "unstar"). */
+    /**
+     * Unsaves a thread (formerly "unstar").
+     *
+     * @param id - The thread ID.
+     */
     unsaveThread(id) {
         return this.simple('GET', 'unsave', { id }, entities_1.StatusOkSchema);
     }
+    /**
+     * Pins a thread.
+     *
+     * @param id - The thread ID.
+     */
     pinThread(id) {
         return this.simple('GET', 'pin', { id }, entities_1.StatusOkSchema);
     }
+    /**
+     * Unpins a thread.
+     *
+     * @param id - The thread ID.
+     */
     unpinThread(id) {
         return this.simple('GET', 'unpin', { id }, entities_1.StatusOkSchema);
     }
-    /** Moves a thread to another channel. */
+    /**
+     * 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) {
         return this.simple('GET', 'move_to_channel', { ...args }, entities_1.ThreadSchema);
     }
+    /**
+     * 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) {
         return this.simple('POST', 'mark_read', { ...args }, entities_1.StatusOkSchema);
     }
+    /**
+     * 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) {
         return this.simple('POST', 'mark_unread', { ...args }, entities_1.StatusOkSchema);
     }
+    /**
+     * 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) {
         return this.simple('POST', 'mark_unread_for_others', { ...args }, entities_1.StatusOkSchema);
     }
     /**
      * 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) {
         if (!args.workspaceId && !args.channelId) {
@@ -95,25 +211,104 @@ class ThreadsClient extends base_client_1.BaseClient {
         }
         return this.simple('POST', 'mark_all_read', { ...args }, entities_1.StatusOkSchema);
     }
+    /**
+     * Clears unread threads in a workspace.
+     *
+     * @param workspaceId - The workspace ID.
+     */
     clearUnread(workspaceId) {
         return this.simple('GET', 'clear_unread', { workspaceId }, entities_1.StatusOkSchema);
     }
     /**
      * 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) {
         return this.simple('GET', 'get_unread', { workspaceId }, GetUnreadResponseSchema);
     }
+    /**
+     * 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) {
         return this.simple('GET', 'mute', { ...args }, entities_1.ThreadSchema);
     }
+    /**
+     * 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) {
         return this.simple('GET', 'unmute', { id }, entities_1.ThreadSchema);
     }
+    /**
+     * 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) {
         return this.addCommentWithAction(args, 'close');
     }
+    /**
+     * 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) {
         return this.addCommentWithAction(args, 'reopen');
     }

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

@@ -11,17 +11,45 @@ const base_client_1 = require("./base-client");
  * `loginWithTodoist` are the available entry points.
  */
 class UsersClient extends base_client_1.BaseClient {
-    /** Registers a new user via the Todoist-ID bridge. */
+    /**
+     * Registers a new user via the Todoist-ID bridge.
+     *
+     * @param args - Registration arguments.
+     * @param args.name - The new user's full name.
+     * @param args.email - The new user's email.
+     * @param args.password - The new user's password.
+     * @param args.lang - Optional preferred language.
+     * @param args.acceptTerms - Optional flag confirming the user accepts the terms of service.
+     * @returns The newly registered user object.
+     */
     register(args) {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/register`, args, entities_1.UserSchema, { authed: false });
     }
-    /** Logs in an existing user. */
+    /**
+     * Logs in an existing user.
+     *
+     * @param args - Login credentials.
+     * @param args.email - The user's email.
+     * @param args.password - The user's password.
+     * @param args.setSessionCookie - Optional flag to set a session cookie (default: true).
+     * @returns The authenticated user object.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.users.login({
+     *   email: 'user@example.com',
+     *   password: 'secret',
+     * })
+     * ```
+     */
     login(args) {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/login`, args, entities_1.UserSchema, { authed: false });
     }
     /**
      * Logs in using a valid token (sent via Authorization header). The SDK
      * client is already configured with the token, so no args are needed.
+     *
+     * @returns The authenticated user object.
      */
     loginWithToken() {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/login_with_token`, undefined, entities_1.UserSchema);
@@ -30,17 +58,35 @@ class UsersClient extends base_client_1.BaseClient {
      * Exchanges the browser's Todoist web-session cookie for a Comms session.
      * Only useful when running in a browser context on the shared Todoist
      * registrable domain — the cookie is sent automatically by the browser.
+     *
+     * @returns The authenticated user object.
      */
     loginWithTodoist() {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/login_with_todoist`, {}, entities_1.UserSchema, { authed: false });
     }
-    /** Logs in (and auto-signs-up) via a Google ID token. */
+    /**
+     * Logs in (and auto-signs-up) via a Google ID token.
+     *
+     * @param args - Google login arguments.
+     * @param args.idToken - The Google ID token.
+     * @param args.nonce - The nonce that was sent to Google.
+     * @param args.timezone - Optional user timezone.
+     * @param args.lang - Optional preferred language.
+     * @param args.mfaToken - Optional MFA token from a prior `mfaChallenge` response.
+     * @returns The authenticated user object.
+     */
     loginWithGoogle(args) {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/login_with_google`, args, entities_1.UserSchema, { authed: false });
     }
     /**
      * Completes an MFA challenge issued by `loginWithGoogle` (returns an MFA
      * token to pass back to `loginWithGoogle.mfaToken`).
+     *
+     * @param args - MFA challenge arguments.
+     * @param args.challengeId - The challenge ID from the prior login attempt.
+     * @param args.factor - The MFA factor identifier.
+     * @param args.methodType - The MFA method type.
+     * @returns The MFA token to forward to `loginWithGoogle`.
      */
     mfaChallenge(args) {
         return (0, http_client_1.request)({
@@ -63,7 +109,17 @@ class UsersClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Returns the user associated with the current access token. */
+    /**
+     * Gets the user associated with the current access token.
+     *
+     * @returns The authenticated user's information.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.users.getSessionUser()
+     * console.log(user.fullName, user.email)
+     * ```
+     */
     getSessionUser() {
         return this.get(`${endpoints_1.ENDPOINT_USERS}/get_session_user`, undefined, entities_1.UserSchema);
     }
@@ -71,32 +127,74 @@ class UsersClient extends base_client_1.BaseClient {
      * Fetches a single user. Defaults to the session user when no `id` is
      * passed. Cross-workspace lookups require that the caller and the target
      * share a workspace.
+     *
+     * @param args - Optional lookup arguments.
+     * @param args.id - The user ID. Defaults to the session user.
+     * @param args.workspaceId - Optional workspace ID for cross-workspace lookups.
+     * @param args.asList - Optional flag controlling list-style response.
+     * @returns The user object.
      */
     getUser(args) {
         return this.get(`${endpoints_1.ENDPOINT_USERS}/getone`, args ?? {}, entities_1.UserSchema);
     }
-    /** Looks up a user by their email address. */
+    /**
+     * Looks up a user by their email address.
+     *
+     * @param email - The email to look up.
+     * @returns The user object.
+     */
     getUserByEmail(email) {
         return this.get(`${endpoints_1.ENDPOINT_USERS}/get_by_email`, { email }, entities_1.UserSchema);
     }
     /**
      * Updates the logged-in user's profile. Most fields are proxied to
      * Todoist (full name, password, language, timezone, etc.).
+     *
+     * @param args - The user properties to update.
+     * @returns The updated user object.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.users.update({
+     *   name: 'John Doe',
+     *   timezone: 'America/New_York',
+     * })
+     * ```
      */
     update(args) {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/update`, args, entities_1.UserSchema);
     }
-    /** Updates the user's password. Requires `currentPassword`. */
+    /**
+     * Updates the user's password.
+     *
+     * @param args - Password update arguments.
+     * @param args.newPassword - The new password.
+     * @param args.currentPassword - The user's existing password. Optional — sent for
+     *   re-authentication when the account has a password set.
+     * @returns The updated user object.
+     */
     updatePassword(args) {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/update_password`, args, entities_1.UserSchema);
     }
-    /** Removes the user's avatar. */
+    /**
+     * Removes the user's avatar.
+     *
+     * @returns The updated user object.
+     */
     removeAvatar() {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/remove_avatar`, undefined, entities_1.UserSchema);
     }
     /**
      * Invalidates the current API token and returns the user with a fresh
      * token.
+     *
+     * @returns The user object with the new token.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.users.invalidateToken()
+     * console.log('New token:', user.token)
+     * ```
      */
     invalidateToken() {
         return this.post(`${endpoints_1.ENDPOINT_USERS}/invalidate_token`, undefined, entities_1.UserSchema);
@@ -105,6 +203,8 @@ class UsersClient extends base_client_1.BaseClient {
      * Validates that an arbitrary token is still active. Note this is sent
      * as a GET — the token is read from the query string, not the
      * Authorization header.
+     *
+     * @param token - The token to validate.
      */
     validateToken(token) {
         return (0, http_client_1.request)({
@@ -116,7 +216,18 @@ class UsersClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Marks the user as active on a workspace (presence beacon). */
+    /**
+     * Marks the user as active on a workspace (presence beacon).
+     *
+     * @param args - Heartbeat arguments.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.platform - The platform identifier (e.g., 'mobile', 'desktop', 'api').
+     *
+     * @example
+     * ```typescript
+     * await api.users.heartbeat({ workspaceId: 123, platform: 'api' })
+     * ```
+     */
     heartbeat(args) {
         return (0, http_client_1.request)({
             httpMethod: 'GET',
@@ -127,7 +238,11 @@ class UsersClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Resets the user's presence for a workspace. */
+    /**
+     * Resets the user's presence for a workspace (marks the user as inactive).
+     *
+     * @param workspaceId - The workspace ID.
+     */
     resetPresence(workspaceId) {
         return (0, http_client_1.request)({
             httpMethod: 'POST',
@@ -138,7 +253,12 @@ class UsersClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Checks whether an email address is registered (and verified). */
+    /**
+     * Checks whether an email address is registered (and verified).
+     *
+     * @param email - The email to check.
+     * @returns Object indicating whether the email exists and is verified.
+     */
     checkEmail(email) {
         return (0, http_client_1.request)({
             httpMethod: 'POST',
@@ -152,6 +272,8 @@ class UsersClient extends base_client_1.BaseClient {
     /**
      * Returns the current per-channel mail unsubscribe settings for the
      * caller's primary email.
+     *
+     * @returns Object mapping email-type keys to their opt-out flag.
      */
     getUnsubscribeSettings() {
         return (0, http_client_1.request)({
@@ -163,7 +285,12 @@ class UsersClient extends base_client_1.BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
-    /** Toggles per-email-type opt-out settings. */
+    /**
+     * Toggles per-email-type opt-out settings.
+     *
+     * @param settings - Object mapping email-type keys to their opt-out flag.
+     * @returns Status object with `"ok"` status.
+     */
     updateUnsubscribeSettings(settings) {
         return (0, http_client_1.request)({
             httpMethod: 'POST',