import { PaginationBase, UserSubscribeType } from './base.interface';

/** 查询用户列表请求参数 */
export interface UserListGetReqParams extends PaginationBase {
  /** 应用密钥标志 */
  appToken: string
  /** 用户的uid，可选，如果不传就是查询所有用户，传uid就是查某个用户的信息 */
  uid?: string
}

/** 获取用户列表响应内容 */
export interface UserListGetResData extends PaginationBase {
  /** 用户信息数组 */
  records: UserListGetResDataItem[]
  /** 所有的用户数量 */
  total: number
}

/** 获取用户列表响应用户信息 */
export interface UserListGetResDataItem {
  /** 用户关注时间 */
  createTime: number
  /** 是否可用，也就是用户是否开启接收消息 */
  enable: boolean
  /** 用户头像 */
  headImg: string
  /** 用户昵称 */
  nickName: string
  /** 用户的UID */
  uid: string
}

/** 查询用户列表请求参数V2 */
export interface UserListGetReqParamsV2 extends PaginationBase {
  /** 应用密钥标志 */
  appToken: string
  /** 用户的uid，可选，如果不传就是查询所有用户，传uid就是查某个用户的信息 */
  uid?: string
  /** 可选，不传查询所有用户，true查询拉黑用户，false查询没有拉黑的用户 */
  isBlock?: boolean
  /** 可选，不传查询所有用户，值参考 UserSubscribeType */
  type?: UserSubscribeType
}

/** 获取用户列表响应内容 */
export interface UserListGetResDataV2 extends PaginationBase {
  /** 用户信息数组 */
  records: UserListGetResDataItemV2[]
  /** 所有的用户数量 */
  total: number
}

/**
 * 获取用户列表V2
 * @description 相比旧接口少了enable字段，多了reject[是否拉黑]、id[用户id]、type[用户关注类型]、target[关注的应用/主题名称]
 */
export interface UserListGetResDataItemV2 {
  /** 用户关注时间 */
  createTime: number
  /** 用户头像 */
  headImg: string
  /** 用户昵称 */
  nickName: string
  /** 用户的UID */
  uid: string
  /** 是否拉黑 */
  reject: false
  /** 如果调用删除或者拉黑接口，需要这个id */
  id: number
  /** 关注类型，0：关注应用，1：关注topic */
  type: UserSubscribeType
  /** 关注的应用或者主题名字 */
  target: string
}

/** 删除用户接口请求参数 */
export interface UserRemoveReqBody {
  /** 应用密钥标志 */
  appToken: string
  /** 用户id，通过用户查询接口可以获取 */
  id: number
}

/** 拉黑用户接口请求参数 */
export interface UserRejectReqBody {
  /** 应用密钥标志 */
  appToken: string
  /** 用户id，通过用户查询接口可以获取 */
  id: number
  /** 是否拉黑，true表示拉黑，false表示取消拉黑 */
  reject: boolean
}