Bläddra i källkod

docs(api): 更新预测申报API的返回类型注释

yz 1 vecka sedan
förälder
incheckning
68328b76af
1 ändrade filer med 6 tillägg och 6 borttagningar
  1. 6 6
      src/api/forecast/index.js

+ 6 - 6
src/api/forecast/index.js

@@ -101,15 +101,15 @@ import request from '@/router/axios'
  * @param {number} [current=1] - 当前页码
  * @param {number} [size=10] - 每页数量
  * @param {ForecastQueryParams} [params={}] - 查询参数
- * @returns {Promise<ApiResponse<ForecastPageResponse>>} 预测申报列表响应
+ * @returns {Promise<AxiosResponse<ForecastPageResponse>>} 预测申报列表响应
  * @description 获取经销商销售预测申报列表,支持多条件查询和分页
  * @example
  * // 获取第一页10条数据
  * const result = await getForecastList(1, 10)
- * 
+ *
  * // 按年月查询
  * const result = await getForecastList(1, 10, { year: 2025, month: 8 })
- * 
+ *
  * // 按客户查询
  * const result = await getForecastList(1, 10, { customerId: 1001 })
  */
@@ -128,7 +128,7 @@ export const getForecastList = async (current = 1, size = 10, params = {}) => {
 /**
  * 添加预测申报
  * @param {ForecastFormData} data - 预测申报表单数据
- * @returns {Promise<ApiResponse<boolean>>} 添加结果响应
+ * @returns {Promise<AxiosResponse<boolean>>} 添加结果响应
  * @description 创建新的经销商销售预测申报记录
  * @example
  * const formData = {
@@ -162,7 +162,7 @@ export const addForecast = async (data) => {
 /**
  * 修改预测申报
  * @param {ForecastFormData} data - 预测申报表单数据(必须包含id)
- * @returns {Promise<ApiResponse<boolean>>} 修改结果响应
+ * @returns {Promise<AxiosResponse<boolean>>} 修改结果响应
  * @description 更新现有的经销商销售预测申报记录,只有未审批状态的记录可以修改
  * @example
  * const formData = {
@@ -200,7 +200,7 @@ export const updateForecast = async (data) => {
 /**
  * 获取预测申报详情
  * @param {string|number} id - 预测申报ID
- * @returns {Promise<ApiResponse<ForecastItem>>} 预测申报详情响应
+ * @returns {Promise<AxiosResponse<ForecastItem>>} 预测申报详情响应
  * @description 根据ID获取预测申报的详细信息
  * @example
  * const result = await getForecastDetail('1954789198347063298')