fix: fix the response types for moderation

Author: vishalnarkhede

src/moderation.ts

@@ -1,6 +1,9 @@
 import type {
   APIResponse,
+  BlockListResponse,
+  CheckResponse,
   CustomCheckFlag,
+  CustomCheckResponse,
   GetConfigResponse,
   GetUserModerationReportOptions,
   GetUserModerationReportResponse,
@@ -24,6 +27,8 @@ import type {
   ReviewQueueResponse,
   ReviewQueueSort,
   SubmitActionOptions,
+  SubmitActionResponse,
+  UnmuteUserResponse,
   UpsertConfigResponse,
   UpsertModerationRuleResponse,
 } from './types';
@@ -135,7 +140,7 @@ export class Moderation {
       user_id?: string;
     },
   ) {
-    return await this.client.post<{ item_id: string } & APIResponse>(
+    return await this.client.post<UnmuteUserResponse>(
       this.client.baseURL + '/api/v2/moderation/unmute',
       {
         target_ids: [targetID],
@@ -209,7 +214,7 @@ export class Moderation {
   }
 
   async deleteConfig(key: string, data?: { team?: string }) {
-    return await this.client.delete(
+    return await this.client.delete<APIResponse>(
       this.client.baseURL + '/api/v2/moderation/config/' + key,
       data,
     );
@@ -241,7 +246,7 @@ export class Moderation {
     itemID: string,
     options: SubmitActionOptions = {},
   ) {
-    return await this.client.post<{ item_id: string } & APIResponse>(
+    return await this.client.post<SubmitActionResponse>(
       this.client.baseURL + '/api/v2/moderation/submit_action',
       {
         action_type: actionType,
@@ -281,14 +286,17 @@ export class Moderation {
       test_mode?: boolean;
     },
   ) {
-    return await this.client.post(this.client.baseURL + `/api/v2/moderation/check`, {
-      entity_type: entityType,
-      entity_id: entityID,
-      entity_creator_id: entityCreatorID,
-      moderation_payload: moderationPayload,
-      config_key: configKey,
-      options,
-    });
+    return await this.client.post<CheckResponse>(
+      this.client.baseURL + `/api/v2/moderation/check`,
+      {
+        entity_type: entityType,
+        entity_id: entityID,
+        entity_creator_id: entityCreatorID,
+        moderation_payload: moderationPayload,
+        config_key: configKey,
+        options,
+      },
+    );
   }
 
   /**
@@ -368,15 +376,16 @@ export class Moderation {
     },
     flags: CustomCheckFlag[],
   ) {
-    return await this.client.post<
-      { id: string; item: ReviewQueueItem; status: string } & APIResponse
-    >(this.client.baseURL + `/api/v2/moderation/custom_check`, {
-      entity_type: entityType,
-      entity_id: entityID,
-      entity_creator_id: entityCreatorID,
-      moderation_payload: moderationPayload,
-      flags,
-    });
+    return await this.client.post<CustomCheckResponse>(
+      this.client.baseURL + `/api/v2/moderation/custom_check`,
+      {
+        entity_type: entityType,
+        entity_id: entityID,
+        entity_creator_id: entityCreatorID,
+        moderation_payload: moderationPayload,
+        flags,
+      },
+    );
   }
 
   /**
@@ -446,8 +455,75 @@ export class Moderation {
    * @returns
    */
   async deleteModerationRule(id: string) {
-    return await this.client.delete(
+    return await this.client.delete<APIResponse>(
       this.client.baseURL + '/api/v2/moderation/moderation_rule/' + id,
     );
   }
+
+  /**
+   * Bulk upload a domain blocklist from a URL, S3 path, or file upload
+   * @param {Object} options Bulk upload options
+   * @param {string} options.name Name of the blocklist
+   * @param {string} options.type Type of blocklist ('domains' or 'domain_allowlist')
+   * @param {string} [options.team] Team ID the blocklist belongs to
+   * @param {boolean} [options.is_leet_check_enabled] Enable leet check
+   * @param {boolean} [options.is_plural_check_enabled] Enable plural check
+   * @param {string} [options.url] Publicly accessible URL to download the domain list from
+   * @param {string} [options.s3_path] S3 path to the file (e.g., "12345/blocklists/my-list.txt")
+   * @param {File} [options.file] File to upload (for multipart form data)
+   * @returns {Promise<APIResponse & {blocklist: BlockListResponse, domain_count: number}>}
+   */
+  async bulkUploadBlockList(options: {
+    name: string;
+    type: 'domains' | 'domain_allowlist';
+    team?: string;
+    is_leet_check_enabled?: boolean;
+    is_plural_check_enabled?: boolean;
+    url?: string;
+    s3_path?: string;
+    file?: File;
+  }): Promise<APIResponse & { blocklist: BlockListResponse; domain_count: number }> {
+    // If file is provided, use FormData; otherwise use JSON
+    if (options.file) {
+      const FormData = require('form-data');
+      const formData = new FormData();
+      formData.append('name', options.name);
+      formData.append('type', options.type);
+      if (options.team) {
+        formData.append('team', options.team);
+      }
+      if (options.is_leet_check_enabled !== undefined) {
+        formData.append('is_leet_check_enabled', String(options.is_leet_check_enabled));
+      }
+      if (options.is_plural_check_enabled !== undefined) {
+        formData.append(
+          'is_plural_check_enabled',
+          String(options.is_plural_check_enabled),
+        );
+      }
+      formData.append('file', options.file);
+
+      return (await (this.client as any).doAxiosRequest(
+        'postForm',
+        this.client.baseURL + '/api/v2/blocklists/bulk-upload',
+        formData,
+        {
+          headers: formData.getHeaders ? formData.getHeaders() : {},
+        },
+      )) as Promise<APIResponse & { blocklist: any; domain_count: number }>;
+    } else {
+      // Use JSON for URL or S3 path
+      return await this.client.post<
+        APIResponse & { blocklist: any; domain_count: number }
+      >(this.client.baseURL + '/api/v2/blocklists/bulk-upload', {
+        name: options.name,
+        type: options.type,
+        team: options.team,
+        is_leet_check_enabled: options.is_leet_check_enabled,
+        is_plural_check_enabled: options.is_plural_check_enabled,
+        url: options.url,
+        s3_path: options.s3_path,
+      });
+    }
+  }
 }

src/types.ts

@@ -801,6 +801,11 @@ export type MuteUserResponse = APIResponse & {
   mute?: MuteResponse;
   mutes?: Array<Mute>;
   own_user?: OwnUserResponse;
+  non_existing_users?: string[];
+};
+
+export type UnmuteUserResponse = APIResponse & {
+  non_existing_users?: string[];
 };
 
 export type BlockUserAPIResponse = APIResponse & {
@@ -3685,6 +3690,7 @@ export type ReviewQueueItem = {
   reviewed_at: string;
   status: string;
   updated_at: string;
+  latest_moderator_action?: string;
 };
 
 export type CustomCheckFlag = {
@@ -3726,6 +3732,10 @@ export type SubmitActionOptions = {
   user_id?: string;
 };
 
+export type SubmitActionResponse = APIResponse & {
+  item?: ReviewQueueItem;
+};
+
 export type GetUserModerationReportResponse = {
   user: UserResponse;
   user_blocks?: Array<{
@@ -3736,6 +3746,19 @@ export type GetUserModerationReportResponse = {
   user_mutes?: Mute[];
 };
 
+export type CheckResponse = APIResponse & {
+  status: string;
+  task_id?: string;
+  recommended_action: string;
+  item?: ReviewQueueItem;
+};
+
+export type CustomCheckResponse = APIResponse & {
+  id: string;
+  item: ReviewQueueItem;
+  status: string;
+};
+
 export type QueryModerationConfigsFilters = QueryFilters<
   {
     key?: string;
@@ -3787,6 +3810,12 @@ export type ReviewQueueFilters = QueryFilters<
     entity_id?:
       | RequireOnlyOne<Pick<QueryFilter<ReviewQueueItem['entity_id']>, '$eq' | '$in'>>
       | PrimitiveFilter<ReviewQueueItem['entity_id']>;
+  } & {
+    entity_creator_id?:
+      | RequireOnlyOne<
+          Pick<QueryFilter<ReviewQueueItem['entity_creator_id']>, '$eq' | '$in'>
+        >
+      | PrimitiveFilter<ReviewQueueItem['entity_creator_id']>;
   } & {
     reviewed?: boolean;
   } & {
@@ -3840,6 +3869,7 @@ export type ReviewQueueFilters = QueryFilters<
   } & {
     recommended_action?: RequireOnlyOne<{
       $eq?: string;
+      $in?: string[];
     }>;
   } & {
     flagged_user_id?: RequireOnlyOne<{
@@ -3852,6 +3882,7 @@ export type ReviewQueueFilters = QueryFilters<
   } & {
     label?: RequireOnlyOne<{
       $eq?: string;
+      $in?: string[];
     }>;
   } & {
     reporter_type?: RequireOnlyOne<{
@@ -3866,6 +3897,24 @@ export type ReviewQueueFilters = QueryFilters<
     date_range?: RequireOnlyOne<{
       $eq?: string; // Format: "date1_date2"
     }>;
+  } & {
+    latest_moderator_action?:
+      | RequireOnlyOne<
+          Pick<QueryFilter<ReviewQueueItem['latest_moderator_action']>, '$eq' | '$in'>
+        >
+      | PrimitiveFilter<ReviewQueueItem['latest_moderator_action']>;
+  } & {
+    flags_count?: RequireOnlyOne<{
+      $eq?: number;
+    }>;
+  } & {
+    ai_text_severity?: RequireOnlyOne<{
+      $eq?: string;
+    }>;
+  } & {
+    channel_cid?: RequireOnlyOne<{
+      $eq?: string;
+    }>;
   }
 >;
 
@@ -3877,8 +3926,25 @@ export type QueryModerationConfigsSort = Array<Sort<'key' | 'created_at' | 'upda
 
 export type ReviewQueuePaginationOptions = Pager;
 
+export type FilterConfigResponse = {
+  llm_labels: string[];
+  ai_text_labels?: string[];
+};
+
+export type ModerationActionConfig = {
+  entity_type: string;
+  order: number;
+  action: string;
+  icon: string;
+  description: string;
+  custom?: Record<string, unknown>;
+};
+
 export type ReviewQueueResponse = {
   items: ReviewQueueItem[];
+  action_config?: Record<string, ModerationActionConfig[]>;
+  filter_config?: FilterConfigResponse;
+  stats?: Record<string, unknown>;
   next?: string;
   prev?: string;
 };