[CHAT-1823] Add async deleteChannels endpoint (#769)

Co-authored-by: Amin Mahboubi <amin@getstream.io>
Co-authored-by: Amin Mahboubi <aminmahboobi@gmail.com>

src/client.ts

@@ -114,6 +114,7 @@ import {
   CampaignData,
   OGAttachment,
   TaskStatus,
+  TaskResponse,
 } from './types';
 
 function isString(x: unknown): x is string {
@@ -3305,4 +3306,19 @@ export class StreamChat<
   async getTask(id: string) {
     return this.get<APIResponse & TaskStatus>(`${this.baseURL}/tasks/${id}`);
   }
+
+  /**
+   * deleteChannels - Deletes a list of channel
+   *
+   * @param {string[]} cids Channel CIDs
+   * @param {boolean} [options.hard_delete] Defines if the channel is hard deleted or not
+   *
+   * @return {TaskResponse} A task ID
+   */
+  async deleteChannels(cids: string[], options: { hard_delete?: boolean } = {}) {
+    return await this.post<APIResponse & TaskResponse>(
+      this.baseURL + `/channels/delete`,
+      { cids, ...options },
+    );
+  }
 }

src/types.ts

@@ -2122,6 +2122,10 @@ export type User<UserType = UnknownType> = UserType & {
   username?: string;
 };
 
+export type TaskResponse = {
+  task_id: string;
+};
+
 export type SegmentData = {
   description: string;
   // TODO: define this type in more detail