deprecate delete user endpoint

GetStream · Nov 7, 2023 · 41c6338 · 41c6338
1 parent 6a85445
commit 41c6338
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/__tests__/users.test.ts b/__tests__/users.test.ts
@@ -191,10 +191,9 @@ describe("user API", () => {
   });
 
   it("delete", async () => {
-    const response = await client.deleteUser({ userId: newUser.id });
+    const response = await client.deleteUsers({ user_ids: [newUser.id] });
 
-    expect(response.user?.id).toBe(newUser.id);
-    expect(response.user?.custom.color).toBe("blue");
+    expect(response).toBeDefined();
   });
 
   afterAll(async () => {

diff --git a/src/StreamClient.ts b/src/StreamClient.ts
@@ -241,6 +241,11 @@ export class StreamClient {
     return this.usersApi.deactivateUsers({ deactivateUsersRequest });
   };
 
+  /**
+   * @deprecated use `deleteUsers` instead
+   * @param deleteUsersRequest
+   * @returns
+   */
   deleteUser = async (request: DeleteUserRequest) => {
     const response = await this.usersApi.deleteUser(request);
     response.user = this.mapCustomDataAfterReceive(response.user);