@doist/comms-sdk 0.2.1 → 0.3.0

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

@@ -12,9 +12,13 @@ class WorkspaceUsersClient extends base_client_1.BaseClient {
     /**
      * Returns a list of workspace user objects for the given workspace id.
      *
+     * Removed users are excluded by default; set `args.includeRemoved` to `true` to include them.
+     * The Comms API always returns removed users, so the filtering happens client-side.
+     *
      * @param args - The arguments for getting workspace users.
      * @param args.workspaceId - The workspace ID.
      * @param args.archived - Optional flag to filter archived users.
+     * @param args.includeRemoved - Include users removed from the workspace. Defaults to `false`.
      * @returns An array of workspace user objects.
      *
      * @example
@@ -24,6 +28,7 @@ class WorkspaceUsersClient extends base_client_1.BaseClient {
      * ```
      */
     getWorkspaceUsers(args) {
+        const includeRemoved = args.includeRemoved ?? false;
         return (0, http_client_1.request)({
             httpMethod: 'GET',
             baseUri: this.getBaseUri(),
@@ -31,7 +36,12 @@ class WorkspaceUsersClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, archived: args.archived },
             customFetch: this.customFetch,
-        }).then((response) => response.data.map((user) => entities_1.WorkspaceUserSchema.parse(user)));
+        }).then((response) => {
+            const rawUsers = includeRemoved
+                ? response.data
+                : response.data.filter((user) => !user.removed);
+            return rawUsers.map((user) => entities_1.WorkspaceUserSchema.parse(user));
+        });
     }
     /**
      * Returns a list of workspace user IDs for the given workspace id.

package/dist/esm/clients/workspace-users-client.js

@@ -9,9 +9,13 @@ export class WorkspaceUsersClient extends BaseClient {
     /**
      * Returns a list of workspace user objects for the given workspace id.
      *
+     * Removed users are excluded by default; set `args.includeRemoved` to `true` to include them.
+     * The Comms API always returns removed users, so the filtering happens client-side.
+     *
      * @param args - The arguments for getting workspace users.
      * @param args.workspaceId - The workspace ID.
      * @param args.archived - Optional flag to filter archived users.
+     * @param args.includeRemoved - Include users removed from the workspace. Defaults to `false`.
      * @returns An array of workspace user objects.
      *
      * @example
@@ -21,6 +25,7 @@ export class WorkspaceUsersClient extends BaseClient {
      * ```
      */
     getWorkspaceUsers(args) {
+        const includeRemoved = args.includeRemoved ?? false;
         return request({
             httpMethod: 'GET',
             baseUri: this.getBaseUri(),
@@ -28,7 +33,12 @@ export class WorkspaceUsersClient extends BaseClient {
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, archived: args.archived },
             customFetch: this.customFetch,
-        }).then((response) => response.data.map((user) => WorkspaceUserSchema.parse(user)));
+        }).then((response) => {
+            const rawUsers = includeRemoved
+                ? response.data
+                : response.data.filter((user) => !user.removed);
+            return rawUsers.map((user) => WorkspaceUserSchema.parse(user));
+        });
     }
     /**
      * Returns a list of workspace user IDs for the given workspace id.

package/dist/types/clients/workspace-users-client.d.ts

@@ -10,9 +10,13 @@ export declare class WorkspaceUsersClient extends BaseClient {
     /**
      * Returns a list of workspace user objects for the given workspace id.
      *
+     * Removed users are excluded by default; set `args.includeRemoved` to `true` to include them.
+     * The Comms API always returns removed users, so the filtering happens client-side.
+     *
      * @param args - The arguments for getting workspace users.
      * @param args.workspaceId - The workspace ID.
      * @param args.archived - Optional flag to filter archived users.
+     * @param args.includeRemoved - Include users removed from the workspace. Defaults to `false`.
      * @returns An array of workspace user objects.
      *
      * @example

package/dist/types/types/requests.d.ts

@@ -346,6 +346,11 @@ export type RemoveGroupUsersArgs = {
 export type GetWorkspaceUsersArgs = {
     workspaceId: number;
     archived?: boolean;
+    /**
+     * Include users who have been removed from the workspace. Defaults to `false`.
+     * The Comms API always returns removed users, so the SDK filters them client-side.
+     */
+    includeRemoved?: boolean;
 };
 export type GetUserByIdArgs = {
     workspaceId: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "0.2.1",
+    "version": "0.3.0",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",