浏览代码

docs(api): 更新发票相关API的返回类型注释

yz 1 月之前
父节点
当前提交
489a605c1c
共有 1 个文件被更改,包括 7 次插入7 次删除
  1. 7 7
      src/api/order/invoice.js

+ 7 - 7
src/api/order/invoice.js

@@ -93,7 +93,7 @@ import { INVOICE_TYPES, INVOICE_STATUS } from '@/views/order/invoice/constants'
  * @param {number} current - 当前页码
  * @param {number} size - 每页大小
  * @param {InvoiceQueryParams} params - 查询参数
- * @returns {Promise<ApiResponse<PageResult<InvoiceItem>>>} 分页查询结果
+ * @returns {Promise<AxiosResponse<ApiResponse<PageResult<InvoiceItem>>>>} 分页查询结果
  */
 export const getList = (current, size, params) => {
   return request({
@@ -110,7 +110,7 @@ export const getList = (current, size, params) => {
 /**
  * 添加发票
  * @param {InvoiceForm} row - 发票表单数据
- * @returns {Promise<ApiResponse<boolean>>} 添加结果
+ * @returns {Promise<AxiosResponse<ApiResponse<boolean>>>} 添加结果
  */
 export const add = (row) => {
   return request({
@@ -123,7 +123,7 @@ export const add = (row) => {
 /**
  * 修改发票
  * @param {InvoiceForm} row - 发票表单数据
- * @returns {Promise<ApiResponse<boolean>>} 修改结果
+ * @returns {Promise<AxiosResponse<ApiResponse<boolean>>>} 修改结果
  */
 export const update = (row) => {
   return request({
@@ -136,7 +136,7 @@ export const update = (row) => {
 /**
  * 删除发票
  * @param {string} ids - 要删除的ID,多个用逗号分隔
- * @returns {Promise<ApiResponse<boolean>>} 删除结果
+ * @returns {Promise<AxiosResponse<ApiResponse<boolean>>>} 删除结果
  */
 export const remove = (ids) => {
   return request({
@@ -151,7 +151,7 @@ export const remove = (ids) => {
 /**
  * 获取发票详情
  * @param {string} id - 发票ID
- * @returns {Promise<ApiResponse<InvoiceItem>>} 发票详情
+ * @returns {Promise<AxiosResponse<ApiResponse<InvoiceItem>>>} 发票详情
  */
 export const getDetail = (id) => {
   return request({
@@ -167,7 +167,7 @@ export const getDetail = (id) => {
  * 批量更新发票状态
  * @param {string[]} ids - 发票ID数组
  * @param {InvoiceStatus} status - 新状态 0-待开票 1-已开票 2-已红冲 3-已作废
- * @returns {Promise<ApiResponse<boolean>>} 更新结果
+ * @returns {Promise<AxiosResponse<ApiResponse<boolean>>>} 更新结果
  */
 export const updateStatus = async (ids, status) => {
   return request({
@@ -183,7 +183,7 @@ export const updateStatus = async (ids, status) => {
 /**
  * 根据订单ID获取发票列表
  * @param {number} orderId - 订单ID
- * @returns {Promise<ApiResponse<InvoiceItem[]>>} 发票列表
+ * @returns {Promise<AxiosResponse<ApiResponse<InvoiceItem[]>>>} 发票列表
  */
 export const getInvoicesByOrderId = (orderId) => {
   return request({