[CHAT-2191] async batch delete users

src/client.ts

@@ -114,7 +114,9 @@ import {
   CampaignData,
   OGAttachment,
   TaskStatus,
+  DeleteUserOptions,
   DeleteChannelsResponse,
+  TaskResponse,
 } from './types';
 
 function isString(x: unknown): x is string {
@@ -3321,4 +3323,18 @@ export class StreamChat<
       { cids, ...options },
     );
   }
+
+  /**
+   * deleteUsers - Batch Delete Users
+   *
+   * @param {DeleteUserOptions} options Configuration to delete users; which users and how
+   *
+   * @return {APIResponse} A task ID
+   */
+  async deleteUsers(options: DeleteUserOptions) {
+    return await this.post<APIResponse & TaskResponse>(
+      this.baseURL + `/users/delete`,
+      options,
+    );
+  }
 }

src/types.ts

@@ -79,7 +79,6 @@ export type AppSettingsAPIResponse<
         url_enrichment?: boolean;
       }
     >;
-    async_url_enrich_enabled?: boolean;
     auto_translation_enabled?: boolean;
     before_message_send_hook_url?: string;
     campaign_enabled?: boolean;
@@ -1825,7 +1824,6 @@ export type ExportChannelRequest = {
 
 export type ExportChannelOptions = {
   clear_deleted_message_text?: boolean;
-  include_truncated_messages?: boolean;
 };
 
 export type Field = {
@@ -2134,6 +2132,15 @@ export type DeleteChannelsResponse = {
   result: Record<string, string>;
 } & Partial<TaskResponse>;
 
+export type DeleteType = 'soft' | 'hard';
+
+export type DeleteUserOptions = {
+  user: DeleteType;
+  user_ids: string[];
+  conversations?: DeleteType;
+  messages?: DeleteType;
+};
+
 export type SegmentData = {
   description: string;
   // TODO: define this type in more detail