feat：【antd/ele】【mall/trade】优化 api 的注释

apps/web-ele/src/api/mall/trade/afterSale/index.ts

@@ -5,85 +5,49 @@ import type { MallOrderApi } from '#/api/mall/trade/order';
 import { requestClient } from '#/api/request';
 
 export namespace MallAfterSaleApi {
-  /** 商品属性 */
-  export interface ProductProperty {
-    /** 属性的编号 */
-    propertyId?: null | number;
-    /** 属性的名称 */
-    propertyName?: string;
-    /** 属性值的编号 */
-    valueId?: null | number;
-    /** 属性值的名称 */
-    valueName?: string;
-  }
-
   /** 交易售后 */
   export interface AfterSale {
-    /** 售后编号，主键自增 */
-    id?: null | number;
-    /** 售后单号 */
-    no?: string;
-    /** 退款状态 */
-    status?: null | number;
-    /** 售后方式 */
-    way?: null | number;
-    /** 售后类型 */
-    type?: null | number;
-    /** 用户编号 */
-    userId?: null | number;
-    /** 申请原因 */
-    applyReason?: string;
-    /** 补充描述 */
-    applyDescription?: string;
-    /** 补充凭证图片 */
-    applyPicUrls?: string[];
-    /** 交易订单编号 */
-    orderId?: null | number;
-    /** 订单流水号 */
-    orderNo?: string;
-    /** 交易订单项编号 */
-    orderItemId?: null | number;
-    /** 商品 SPU 编号 */
-    spuId?: null | number;
-    /** 商品 SPU 名称 */
-    spuName?: string;
-    /** 商品 SKU 编号 */
-    skuId?: null | number;
-    /** 属性数组 */
-    properties?: ProductProperty[];
-    /** 商品图片 */
-    picUrl?: string;
-    /** 退货商品数量 */
-    count?: null | number;
-    /** 审批时间 */
-    auditTime?: Date;
-    /** 审批人 */
-    auditUserId?: null | number;
-    /** 审批备注 */
-    auditReason?: string;
-    /** 退款金额，单位：分 */
-    refundPrice?: null | number;
-    /** 支付退款编号 */
-    payRefundId?: null | number;
-    /** 退款时间 */
-    refundTime?: Date;
-    /** 退货物流公司编号 */
-    logisticsId?: null | number;
-    /** 退货物流单号 */
-    logisticsNo?: string;
-    /** 退货时间 */
-    deliveryTime?: Date;
-    /** 收货时间 */
-    receiveTime?: Date;
-    /** 收货备注 */
-    receiveReason?: string;
+    id?: number; // 售后编号
+    no?: string; // 售后单号
+    status?: number; // 退款状态
+    way?: number; // 售后方式
+    type?: number; // 售后类型
+    userId?: number; // 用户编号
+    applyReason?: string; // 申请原因
+    applyDescription?: string; // 补充描述
+    applyPicUrls?: string[]; // 补充凭证图片
+    orderId?: number; // 交易订单编号
+    orderNo?: string; // 订单流水号
+    orderItemId?: number; // 交易订单项编号
+    spuId?: number; // 商品 SPU 编号
+    spuName?: string; // 商品 SPU 名称
+    skuId?: number; // 商品 SKU 编号
+    properties?: {
+      propertyId?: number; // 属性的编号
+      propertyName?: string; // 属性的名称
+      valueId?: number; // 属性值的编号
+      valueName?: string; // 属性值的名称
+    }[]; // 属性数组
+    picUrl?: string; // 商品图片
+    count?: number; // 退货商品数量
+    auditTime?: Date; // 审批时间
+    auditUserId?: number; // 审批人
+    auditReason?: string; // 审批备注
+    refundPrice?: number; // 退款金额，单位：分
+    payRefundId?: number; // 支付退款编号
+    refundTime?: Date; // 退款时间
+    logisticsId?: number; // 退货物流公司编号
+    logisticsNo?: string; // 退货物流单号
+    deliveryTime?: Date; // 退货时间
+    receiveTime?: Date; // 收货时间
+    receiveReason?: string; // 收货备注
     order?: MallOrderApi.Order; // 关联订单
     orderItem?: MallOrderApi.OrderItem; // 关联订单项
     logs?: any[]; // 关联售后日志
   }
 
   /** 拒绝售后请求 */
-  export interface DisagreeRequest {
+  export interface AfterSaleDisagreeReqVO {
     /** 售后编号 */
     id: number;
     /** 拒绝原因 */
@@ -112,7 +76,9 @@ export function agreeAfterSale(id: number) {
 }
 
 /** 拒绝售后 */
-export function disagreeAfterSale(data: MallAfterSaleApi.DisagreeRequest) {
+export function disagreeAfterSale(
+  data: MallAfterSaleApi.AfterSaleDisagreeReqVO,
+) {
   return requestClient.put('/trade/after-sale/disagree', data);
 }