feat：【antd】【crm】api 请求的注释优化

apps/web-ele/src/api/crm/statistics/customer.ts

@@ -1,15 +1,24 @@
 import { requestClient } from '#/api/request';
 
 export namespace CrmStatisticsCustomerApi {
-  /** 客户总量分析(按日期) */
-  export interface CustomerSummaryByDate {
+  /** 客户统计请求 */
+  export interface CustomerSummaryReqVO {
+    times: string[];
+    interval: number;
+    deptId: number;
+    userId: number;
+    userIds: number[];
+  }
+
+  /** 客户总量分析(按日期)响应 */
+  export interface CustomerSummaryByDateRespVO {
     time: string;
     customerCreateCount: number;
     customerDealCount: number;
   }
 
-  /** 客户总量分析(按用户) */
-  export interface CustomerSummaryByUser {
+  /** 客户总量分析(按用户)响应 */
+  export interface CustomerSummaryByUserRespVO {
     ownerUserName: string;
     customerCreateCount: number;
     customerDealCount: number;
@@ -17,28 +26,28 @@ export namespace CrmStatisticsCustomerApi {
     receivablePrice: number;
   }
 
-  /** 客户跟进次数分析(按日期) */
-  export interface FollowUpSummaryByDate {
+  /** 客户跟进次数分析(按日期)响应 */
+  export interface FollowUpSummaryByDateRespVO {
     time: string;
     followUpRecordCount: number;
     followUpCustomerCount: number;
   }
 
-  /** 客户跟进次数分析(按用户) */
-  export interface FollowUpSummaryByUser {
+  /** 客户跟进次数分析(按用户)响应 */
+  export interface FollowUpSummaryByUserRespVO {
     ownerUserName: string;
     followupRecordCount: number;
     followupCustomerCount: number;
   }
 
-  /** 客户跟进方式统计 */
-  export interface FollowUpSummaryByType {
+  /** 客户跟进方式统计响应 */
+  export interface FollowUpSummaryByTypeRespVO {
     followUpType: string;
     followUpRecordCount: number;
   }
 
-  /** 合同摘要信息 */
-  export interface CustomerContractSummary {
+  /** 合同摘要信息响应 */
+  export interface CustomerContractSummaryRespVO {
     customerName: string;
     contractName: string;
     totalPrice: number;
@@ -51,54 +60,46 @@ export namespace CrmStatisticsCustomerApi {
     orderDate: Date;
   }
 
-  /** 客户公海分析(按日期) */
-  export interface PoolSummaryByDate {
+  /** 客户公海分析(按日期)响应 */
+  export interface PoolSummaryByDateRespVO {
     time: string;
     customerPutCount: number;
     customerTakeCount: number;
   }
 
-  /** 客户公海分析(按用户) */
-  export interface PoolSummaryByUser {
+  /** 客户公海分析(按用户)响应 */
+  export interface PoolSummaryByUserRespVO {
     ownerUserName: string;
     customerPutCount: number;
     customerTakeCount: number;
   }
 
-  /** 客户成交周期(按日期) */
-  export interface CustomerDealCycleByDate {
+  /** 客户成交周期(按日期)响应 */
+  export interface CustomerDealCycleByDateRespVO {
     time: string;
     customerDealCycle: number;
   }
 
-  /** 客户成交周期(按用户) */
-  export interface CustomerDealCycleByUser {
+  /** 客户成交周期(按用户)响应 */
+  export interface CustomerDealCycleByUserRespVO {
     ownerUserName: string;
     customerDealCycle: number;
     customerDealCount: number;
   }
 
-  /** 客户成交周期(按地区) */
-  export interface CustomerDealCycleByArea {
+  /** 客户成交周期(按地区)响应 */
+  export interface CustomerDealCycleByAreaRespVO {
     areaName: string;
     customerDealCycle: number;
     customerDealCount: number;
   }
 
-  /** 客户成交周期(按产品) */
-  export interface CustomerDealCycleByProduct {
+  /** 客户成交周期(按产品)响应 */
+  export interface CustomerDealCycleByProductRespVO {
     productName: string;
     customerDealCycle: number;
     customerDealCount: number;
   }
-
-  export interface CustomerSummaryParams {
-    times: string[];
-    interval: number;
-    deptId: number;
-    userId: number;
-    userIds: number[];
-  }
 }
 
 export function getDatas(activeTabName: any, params: any) {
@@ -167,69 +168,63 @@ export function getChartDatas(activeTabName: any, params: any) {
 
 /** 客户总量分析(按日期) */
 export function getCustomerSummaryByDate(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.CustomerSummaryByDate[]>(
-    '/crm/statistics-customer/get-customer-summary-by-date',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.CustomerSummaryByDateRespVO[]
+  >('/crm/statistics-customer/get-customer-summary-by-date', { params });
 }
 
 /** 客户总量分析(按用户) */
 export function getCustomerSummaryByUser(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.CustomerSummaryByUser[]>(
-    '/crm/statistics-customer/get-customer-summary-by-user',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.CustomerSummaryByUserRespVO[]
+  >('/crm/statistics-customer/get-customer-summary-by-user', { params });
 }
 
 /** 客户跟进次数分析(按日期) */
 export function getFollowUpSummaryByDate(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.FollowUpSummaryByDate[]>(
-    '/crm/statistics-customer/get-follow-up-summary-by-date',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.FollowUpSummaryByDateRespVO[]
+  >('/crm/statistics-customer/get-follow-up-summary-by-date', { params });
 }
 
 /** 客户跟进次数分析(按用户) */
 export function getFollowUpSummaryByUser(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.FollowUpSummaryByUser[]>(
-    '/crm/statistics-customer/get-follow-up-summary-by-user',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.FollowUpSummaryByUserRespVO[]
+  >('/crm/statistics-customer/get-follow-up-summary-by-user', { params });
 }
 
 /** 获取客户跟进方式统计数 */
 export function getFollowUpSummaryByType(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.FollowUpSummaryByType[]>(
-    '/crm/statistics-customer/get-follow-up-summary-by-type',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.FollowUpSummaryByTypeRespVO[]
+  >('/crm/statistics-customer/get-follow-up-summary-by-type', { params });
 }
 
 /** 合同摘要信息(客户转化率页面) */
 export function getContractSummary(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.CustomerContractSummary[]>(
-    '/crm/statistics-customer/get-contract-summary',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.CustomerContractSummaryRespVO[]
+  >('/crm/statistics-customer/get-contract-summary', { params });
 }
 
 /** 获取客户公海分析(按日期) */
 export function getPoolSummaryByDate(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.PoolSummaryByDate[]>(
+  return requestClient.get<CrmStatisticsCustomerApi.PoolSummaryByDateRespVO[]>(
     '/crm/statistics-customer/get-pool-summary-by-date',
     { params },
   );
@@ -237,9 +232,9 @@ export function getPoolSummaryByDate(
 
 /** 获取客户公海分析(按用户) */
 export function getPoolSummaryByUser(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.PoolSummaryByUser[]>(
+  return requestClient.get<CrmStatisticsCustomerApi.PoolSummaryByUserRespVO[]>(
     '/crm/statistics-customer/get-pool-summary-by-user',
     { params },
   );
@@ -247,39 +242,36 @@ export function getPoolSummaryByUser(
 
 /** 获取客户成交周期(按日期) */
 export function getCustomerDealCycleByDate(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.CustomerDealCycleByDate[]>(
-    '/crm/statistics-customer/get-customer-deal-cycle-by-date',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.CustomerDealCycleByDateRespVO[]
+  >('/crm/statistics-customer/get-customer-deal-cycle-by-date', { params });
 }
 
 /** 获取客户成交周期(按用户) */
 export function getCustomerDealCycleByUser(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.CustomerDealCycleByUser[]>(
-    '/crm/statistics-customer/get-customer-deal-cycle-by-user',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.CustomerDealCycleByUserRespVO[]
+  >('/crm/statistics-customer/get-customer-deal-cycle-by-user', { params });
 }
 
 /** 获取客户成交周期(按地区) */
 export function getCustomerDealCycleByArea(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
-  return requestClient.get<CrmStatisticsCustomerApi.CustomerDealCycleByArea[]>(
-    '/crm/statistics-customer/get-customer-deal-cycle-by-area',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsCustomerApi.CustomerDealCycleByAreaRespVO[]
+  >('/crm/statistics-customer/get-customer-deal-cycle-by-area', { params });
 }
 
 /** 获取客户成交周期(按产品) */
 export function getCustomerDealCycleByProduct(
-  params: CrmStatisticsCustomerApi.CustomerSummaryParams,
+  params: CrmStatisticsCustomerApi.CustomerSummaryReqVO,
 ) {
   return requestClient.get<
-    CrmStatisticsCustomerApi.CustomerDealCycleByProduct[]
+    CrmStatisticsCustomerApi.CustomerDealCycleByProductRespVO[]
   >('/crm/statistics-customer/get-customer-deal-cycle-by-product', { params });
 }

apps/web-ele/src/api/crm/statistics/funnel.ts

@@ -3,22 +3,22 @@ import type { PageResult } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace CrmStatisticsFunnelApi {
-  /** 销售漏斗统计数据 */
-  export interface FunnelSummary {
+  /** 销售漏斗统计数据响应 */
+  export interface FunnelSummaryRespVO {
     customerCount: number; // 客户数
     businessCount: number; // 商机数
     businessWinCount: number; // 赢单数
   }
 
-  /** 商机分析(按日期) */
-  export interface BusinessSummaryByDate {
+  /** 商机分析(按日期)响应 */
+  export interface BusinessSummaryByDateRespVO {
     time: string; // 时间
     businessCreateCount: number; // 商机数
     totalPrice: number | string; // 商机金额
   }
 
-  /** 商机转化率分析(按日期) */
-  export interface BusinessInversionRateSummaryByDate {
+  /** 商机转化率分析(按日期)响应 */
+  export interface BusinessInversionRateSummaryByDateRespVO {
     time: string; // 时间
     businessCount: number; // 商机数量
     businessWinCount: number; // 赢单商机数
@@ -61,7 +61,7 @@ export function getChartDatas(activeTabName: any, params: any) {
 
 /** 获取销售漏斗统计数据 */
 export function getFunnelSummary(params: any) {
-  return requestClient.get<CrmStatisticsFunnelApi.FunnelSummary>(
+  return requestClient.get<CrmStatisticsFunnelApi.FunnelSummaryRespVO>(
     '/crm/statistics-funnel/get-funnel-summary',
     { params },
   );
@@ -77,16 +77,15 @@ export function getBusinessSummaryByEndStatus(params: any) {
 
 /** 获取新增商机分析(按日期) */
 export function getBusinessSummaryByDate(params: any) {
-  return requestClient.get<CrmStatisticsFunnelApi.BusinessSummaryByDate[]>(
-    '/crm/statistics-funnel/get-business-summary-by-date',
-    { params },
-  );
+  return requestClient.get<
+    CrmStatisticsFunnelApi.BusinessSummaryByDateRespVO[]
+  >('/crm/statistics-funnel/get-business-summary-by-date', { params });
 }
 
 /** 获取商机转化率分析(按日期) */
 export function getBusinessInversionRateSummaryByDate(params: any) {
   return requestClient.get<
-    CrmStatisticsFunnelApi.BusinessInversionRateSummaryByDate[]
+    CrmStatisticsFunnelApi.BusinessInversionRateSummaryByDateRespVO[]
   >('/crm/statistics-funnel/get-business-inversion-rate-summary-by-date', {
     params,
   });

apps/web-ele/src/api/crm/statistics/performance.ts

@@ -1,25 +1,27 @@
 import { requestClient } from '#/api/request';
 
 export namespace CrmStatisticsPerformanceApi {
-  /** 员工业绩统计 */
-  export interface Performance {
+  /** 员工业绩统计请求 */
+  export interface PerformanceReqVO {
+    times: string[];
+    deptId: number;
+    userId: number;
+  }
+
+  /** 员工业绩统计响应 */
+  export interface PerformanceRespVO {
     time: string;
     currentMonthCount: number;
     lastMonthCount: number;
     lastYearCount: number;
   }
-  export interface PerformanceParams {
-    times: string[];
-    deptId: number;
-    userId: number;
-  }
 }
 
 /** 员工获得合同金额统计 */
 export function getContractPricePerformance(
-  params: CrmStatisticsPerformanceApi.PerformanceParams,
+  params: CrmStatisticsPerformanceApi.PerformanceReqVO,
 ) {
-  return requestClient.get<CrmStatisticsPerformanceApi.Performance[]>(
+  return requestClient.get<CrmStatisticsPerformanceApi.PerformanceRespVO[]>(
     '/crm/statistics-performance/get-contract-price-performance',
     { params },
   );
@@ -27,9 +29,9 @@ export function getContractPricePerformance(
 
 /** 员工获得回款统计 */
 export function getReceivablePricePerformance(
-  params: CrmStatisticsPerformanceApi.PerformanceParams,
+  params: CrmStatisticsPerformanceApi.PerformanceReqVO,
 ) {
-  return requestClient.get<CrmStatisticsPerformanceApi.Performance[]>(
+  return requestClient.get<CrmStatisticsPerformanceApi.PerformanceRespVO[]>(
     '/crm/statistics-performance/get-receivable-price-performance',
     { params },
   );
@@ -37,9 +39,9 @@ export function getReceivablePricePerformance(
 
 /** 员工获得签约合同数量统计 */
 export function getContractCountPerformance(
-  params: CrmStatisticsPerformanceApi.PerformanceParams,
+  params: CrmStatisticsPerformanceApi.PerformanceReqVO,
 ) {
-  return requestClient.get<CrmStatisticsPerformanceApi.Performance[]>(
+  return requestClient.get<CrmStatisticsPerformanceApi.PerformanceRespVO[]>(
     '/crm/statistics-performance/get-contract-count-performance',
     { params },
   );

apps/web-ele/src/api/crm/statistics/portrait.ts

@@ -3,33 +3,33 @@ import type { PageParam } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace CrmStatisticsPortraitApi {
-  /** 客户基础统计信息 */
-  export interface CustomerBase {
+  /** 客户基础统计响应 */
+  export interface CustomerBaseRespVO {
     customerCount: number;
     dealCount: number;
     dealPortion: number | string;
   }
 
-  /** 客户行业统计信息 */
-  export interface CustomerIndustry extends CustomerBase {
+  /** 客户行业统计响应 */
+  export interface CustomerIndustryRespVO extends CustomerBaseRespVO {
     industryId: number;
     industryPortion: number | string;
   }
 
-  /** 客户来源统计信息 */
-  export interface CustomerSource extends CustomerBase {
+  /** 客户来源统计响应 */
+  export interface CustomerSourceRespVO extends CustomerBaseRespVO {
     source: number;
     sourcePortion: number | string;
   }
 
-  /** 客户级别统计信息 */
-  export interface CustomerLevel extends CustomerBase {
+  /** 客户级别统计响应 */
+  export interface CustomerLevelRespVO extends CustomerBaseRespVO {
     level: number;
     levelPortion: number | string;
   }
 
-  /** 客户地区统计信息 */
-  export interface CustomerArea extends CustomerBase {
+  /** 客户地区统计响应 */
+  export interface CustomerAreaRespVO extends CustomerBaseRespVO {
     areaId: number;
     areaName: string;
     areaPortion: number | string;
@@ -58,7 +58,7 @@ export function getDatas(activeTabName: any, params: any) {
 
 /** 获取客户行业统计数据 */
 export function getCustomerIndustry(params: PageParam) {
-  return requestClient.get<CrmStatisticsPortraitApi.CustomerIndustry[]>(
+  return requestClient.get<CrmStatisticsPortraitApi.CustomerIndustryRespVO[]>(
     '/crm/statistics-portrait/get-customer-industry-summary',
     { params },
   );
@@ -66,7 +66,7 @@ export function getCustomerIndustry(params: PageParam) {
 
 /** 获取客户来源统计数据 */
 export function getCustomerSource(params: PageParam) {
-  return requestClient.get<CrmStatisticsPortraitApi.CustomerSource[]>(
+  return requestClient.get<CrmStatisticsPortraitApi.CustomerSourceRespVO[]>(
     '/crm/statistics-portrait/get-customer-source-summary',
     { params },
   );
@@ -74,7 +74,7 @@ export function getCustomerSource(params: PageParam) {
 
 /** 获取客户级别统计数据 */
 export function getCustomerLevel(params: PageParam) {
-  return requestClient.get<CrmStatisticsPortraitApi.CustomerLevel[]>(
+  return requestClient.get<CrmStatisticsPortraitApi.CustomerLevelRespVO[]>(
     '/crm/statistics-portrait/get-customer-level-summary',
     { params },
   );
@@ -82,7 +82,7 @@ export function getCustomerLevel(params: PageParam) {
 
 /** 获取客户地区统计数据 */
 export function getCustomerArea(params: PageParam) {
-  return requestClient.get<CrmStatisticsPortraitApi.CustomerArea[]>(
+  return requestClient.get<CrmStatisticsPortraitApi.CustomerAreaRespVO[]>(
     '/crm/statistics-portrait/get-customer-area-summary',
     { params },
   );

apps/web-ele/src/api/crm/statistics/rank.ts

@@ -3,8 +3,8 @@ import type { PageParam } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace CrmStatisticsRankApi {
-  /** 排行统计数据 */
-  export interface Rank {
+  /** 排行统计响应 */
+  export interface RankRespVO {
     count: number;
     nickname: string;
     deptName: string;
@@ -45,7 +45,7 @@ export function getDatas(activeTabName: any, params: any) {
 
 /** 获得合同排行榜 */
 export function getContractPriceRank(params: PageParam) {
-  return requestClient.get<CrmStatisticsRankApi.Rank[]>(
+  return requestClient.get<CrmStatisticsRankApi.RankRespVO[]>(
     '/crm/statistics-rank/get-contract-price-rank',
     { params },
   );
@@ -53,7 +53,7 @@ export function getContractPriceRank(params: PageParam) {
 
 /** 获得回款排行榜 */
 export function getReceivablePriceRank(params: PageParam) {
-  return requestClient.get<CrmStatisticsRankApi.Rank[]>(
+  return requestClient.get<CrmStatisticsRankApi.RankRespVO[]>(
     '/crm/statistics-rank/get-receivable-price-rank',
     { params },
   );
@@ -61,7 +61,7 @@ export function getReceivablePriceRank(params: PageParam) {
 
 /** 签约合同排行 */
 export function getContractCountRank(params: PageParam) {
-  return requestClient.get<CrmStatisticsRankApi.Rank[]>(
+  return requestClient.get<CrmStatisticsRankApi.RankRespVO[]>(
     '/crm/statistics-rank/get-contract-count-rank',
     { params },
   );
@@ -69,7 +69,7 @@ export function getContractCountRank(params: PageParam) {
 
 /** 产品销量排行 */
 export function getProductSalesRank(params: PageParam) {
-  return requestClient.get<CrmStatisticsRankApi.Rank[]>(
+  return requestClient.get<CrmStatisticsRankApi.RankRespVO[]>(
     '/crm/statistics-rank/get-product-sales-rank',
     { params },
   );
@@ -77,7 +77,7 @@ export function getProductSalesRank(params: PageParam) {
 
 /** 新增客户数排行 */
 export function getCustomerCountRank(params: PageParam) {
-  return requestClient.get<CrmStatisticsRankApi.Rank[]>(
+  return requestClient.get<CrmStatisticsRankApi.RankRespVO[]>(
     '/crm/statistics-rank/get-customer-count-rank',
     { params },
   );
@@ -85,7 +85,7 @@ export function getCustomerCountRank(params: PageParam) {
 
 /** 新增联系人数排行 */
 export function getContactsCountRank(params: PageParam) {
-  return requestClient.get<CrmStatisticsRankApi.Rank[]>(
+  return requestClient.get<CrmStatisticsRankApi.RankRespVO[]>(
     '/crm/statistics-rank/get-contacts-count-rank',
     { params },
   );
@@ -93,7 +93,7 @@ export function getContactsCountRank(params: PageParam) {
 
 /** 跟进次数排行 */
 export function getFollowCountRank(params: PageParam) {
-  return requestClient.get<CrmStatisticsRankApi.Rank[]>(
+  return requestClient.get<CrmStatisticsRankApi.RankRespVO[]>(
     '/crm/statistics-rank/get-follow-count-rank',
     { params },
   );
@@ -101,7 +101,7 @@ export function getFollowCountRank(params: PageParam) {
 
 /** 跟进客户数排行 */
 export function getFollowCustomerCountRank(params: PageParam) {
-  return requestClient.get<CrmStatisticsRankApi.Rank[]>(
+  return requestClient.get<CrmStatisticsRankApi.RankRespVO[]>(
     '/crm/statistics-rank/get-follow-customer-count-rank',
     { params },
   );