ZF/yudao-ui-admin-vben
1
0
Fork 0
mirror of https://gitee.com/yudaocode/yudao-ui-admin-vben.git synced 2025-12-30 10:32:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
YunaiV
2025-11-20 08:43:34 +08:00
parent 5743c213c2
commit 4d6eeb2681
16 changed files with 30 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
apps/web-antd/src/api/pay/app/index.ts
View File

@@ -20,21 +20,14 @@ export namespace PayAppApi {
}
/** 更新状态请求 */
export interface UpdateStatusReq {
export interface AppUpdateStatusReqVO {
id: number;
status: number;
}
export interface AppPageReqVO extends PageParam {
name?: string;
appKey?: string;
status?: number;
createTime?: Date[];
}
}
/** 查询支付应用列表 */
export function getAppPage(params: PayAppApi.AppPageReqVO) {
export function getAppPage(params: PageParam) {
return requestClient.get<PageResult<PayAppApi.App>>('/pay/app/page', {
params,
});
@@ -56,7 +49,7 @@ export function updateApp(data: PayAppApi.App) {
}
/** 修改支付应用状态 */
export function updateAppStatus(data: PayAppApi.UpdateStatusReq) {
export function updateAppStatus(data: PayAppApi.AppUpdateStatusReqVO) {
return requestClient.put('/pay/app/update-status', data);
}

22
apps/web-antd/src/api/pay/channel/index.ts
View File

@@ -1,5 +1,3 @@
import type { PageParam, PageResult } from '@vben/request';
import { requestClient } from '#/api/request';
export namespace PayChannelApi {
@@ -16,16 +14,6 @@ export namespace PayChannelApi {
}
}
/** 查询支付渠道列表 */
export function getChannelPage(params: PageParam) {
return requestClient.get<PageResult<PayChannelApi.Channel>>(
'/pay/channel/page',
{
params,
},
);
}
/** 查询支付渠道详情 */
export function getChannel(appId: number, code: string) {
return requestClient.get<PayChannelApi.Channel>('/pay/channel/get', {
@@ -42,13 +30,3 @@ export function createChannel(data: PayChannelApi.Channel) {
export function updateChannel(data: PayChannelApi.Channel) {
return requestClient.put('/pay/channel/update', data);
}
/** 删除支付渠道 */
export function deleteChannel(id: number) {
return requestClient.delete(`/pay/channel/delete?id=${id}`);
}
/** 导出支付渠道 */
export function exportChannel(params: PageParam) {
return requestClient.download('/pay/channel/export-excel', { params });
}

7
apps/web-antd/src/api/pay/demo/order/index.ts
View File

@@ -19,11 +19,6 @@ export namespace DemoOrderApi {
spuId?: number;
createTime?: Date;
}
export interface OrderPageReqVO extends PageParam {
spuId?: number;
createTime?: Date[];
}
}
/** 创建示例订单 */
@@ -32,7 +27,7 @@ export function createDemoOrder(data: DemoOrderApi.Order) {
}
/** 获得示例订单分页 */
export function getDemoOrderPage(params: DemoOrderApi.OrderPageReqVO) {
export function getDemoOrderPage(params: PageParam) {
return requestClient.get<PageResult<DemoOrderApi.Order>>(
'/pay/demo-order/page',
{

14
apps/web-antd/src/api/pay/notify/index.ts
View File

@@ -22,18 +22,6 @@ export namespace PayNotifyApi {
updateTime: Date;
logs?: any[];
}
/** 支付通知任务分页请求 */
export interface NotifyTaskPageReqVO extends PageParam {
appId?: number;
type?: number;
dataId?: number;
status?: number;
merchantOrderId?: string;
merchantRefundId?: string;
merchantTransferId?: string;
createTime?: Date[];
}
}
/** 获得支付通知明细 */
@@ -42,7 +30,7 @@ export function getNotifyTaskDetail(id: number) {
}
/** 获得支付通知分页 */
export function getNotifyTaskPage(params: PayNotifyApi.NotifyTaskPageReqVO) {
export function getNotifyTaskPage(params: PageParam) {
return requestClient.get<PageResult<PayNotifyApi.NotifyTask>>(
'/pay/notify/page',
{

13
apps/web-antd/src/api/pay/order/index.ts
View File

@@ -38,21 +38,10 @@ export namespace PayOrderApi {
createTime: Date;
updateTime: Date;
}
/** 支付订单分页请求 */
export interface OrderPageReqVO extends PageParam {
appId?: number;
channelCode?: string;
merchantOrderId?: string;
channelOrderNo?: string;
no?: string;
status?: number;
createTime?: Date[];
}
}
/** 查询支付订单列表 */
export function getOrderPage(params: PayOrderApi.OrderPageReqVO) {
export function getOrderPage(params: PageParam) {
return requestClient.get<PageResult<PayOrderApi.Order>>('/pay/order/page', {
params,
});

31
apps/web-antd/src/api/pay/refund/index.ts
View File

@@ -36,39 +36,10 @@ export namespace PayRefundApi {
createTime: Date;
updateTime: Date;
}
/** 退款订单分页请求 */
export interface RefundPageReqVO extends PageParam {
merchantId?: number;
appId?: number;
channelId?: number;
channelCode?: string;
orderId?: string;
tradeNo?: string;
merchantOrderId?: string;
merchantRefundNo?: string;
notifyUrl?: string;
notifyStatus?: number;
status?: number;
type?: number;
payAmount?: number;
refundAmount?: number;
reason?: string;
userIp?: string;
channelOrderNo?: string;
channelRefundNo?: string;
channelErrorCode?: string;
channelErrorMsg?: string;
channelExtras?: string;
expireTime?: Date[];
successTime?: Date[];
notifyTime?: Date[];
createTime?: Date[];
}
}
/** 查询退款订单列表 */
export function getRefundPage(params: PayRefundApi.RefundPageReqVO) {
export function getRefundPage(params: PageParam) {
return requestClient.get<PageResult<PayRefundApi.Refund>>(
'/pay/refund/page',
{

15
apps/web-antd/src/api/pay/transfer/index.ts
View File

@@ -25,23 +25,10 @@ export namespace PayTransferApi {
notifyUrl: string;
channelNotifyData: string;
}
/** 转账单分页请求 */
export interface TransferPageReqVO extends PageParam {
no?: string;
appId?: number;
channelCode?: string;
merchantOrderId?: string;
status?: number;
userName?: string;
userAccount?: string;
channelTransferNo?: string;
createTime?: Date[];
}
}
/** 查询转账单列表 */
export function getTransferPage(params: PayTransferApi.TransferPageReqVO) {
export function getTransferPage(params: PageParam) {
return requestClient.get<PageResult<PayTransferApi.Transfer>>(
'/pay/transfer/page',
{

24
apps/web-antd/src/api/pay/wallet/balance/index.ts
View File

@@ -3,11 +3,6 @@ import type { PageParam, PageResult } from '@vben/request';
import { requestClient } from '#/api/request';
export namespace PayWalletApi {
/** 用户钱包查询参数 */
export interface PayWalletUserReq {
userId: number;
}
/** 钱包信息 */
export interface Wallet {
id: number;
@@ -19,32 +14,27 @@ export namespace PayWalletApi {
freezePrice: number;
}
/** 钱包分页请求 */
export interface WalletPageReqVO extends PageParam {
userId?: number;
userType?: number;
balance?: number;
totalExpense?: number;
totalRecharge?: number;
freezePrice?: number;
/** 钱包查询参数 */
export interface WalletUserQueryReqVO {
userId: number;
}
/** 钱包修改余额 */
export interface PayWalletUpdateBalanceReqVO {
export interface WalletUpdateBalanceReqVO {
userId: number;
balance: number;
}
}
/** 查询用户钱包详情 */
export function getWallet(params: PayWalletApi.PayWalletUserReq) {
export function getWallet(params: PayWalletApi.WalletUserQueryReqVO) {
return requestClient.get<PayWalletApi.Wallet>('/pay/wallet/get', {
params,
});
}
/** 查询会员钱包列表 */
export function getWalletPage(params: PayWalletApi.WalletPageReqVO) {
export function getWalletPage(params: PageParam) {
return requestClient.get<PageResult<PayWalletApi.Wallet>>(
'/pay/wallet/page',
{
@@ -55,7 +45,7 @@ export function getWalletPage(params: PayWalletApi.WalletPageReqVO) {
/** 修改会员钱包余额 */
export function updateWalletBalance(
data: PayWalletApi.PayWalletUpdateBalanceReqVO,
data: PayWalletApi.WalletUpdateBalanceReqVO,
) {
return requestClient.put('/pay/wallet/update-balance', data);
}

13
apps/web-ele/src/api/pay/app/index.ts
View File

@@ -20,21 +20,14 @@ export namespace PayAppApi {
}
/** 更新状态请求 */
export interface UpdateStatusReq {
export interface AppUpdateStatusReqVO {
id: number;
status: number;
}
export interface AppPageReqVO extends PageParam {
name?: string;
appKey?: string;
status?: number;
createTime?: Date[];
}
}
/** 查询支付应用列表 */
export function getAppPage(params: PayAppApi.AppPageReqVO) {
export function getAppPage(params: PageParam) {
return requestClient.get<PageResult<PayAppApi.App>>('/pay/app/page', {
params,
});
@@ -56,7 +49,7 @@ export function updateApp(data: PayAppApi.App) {
}
/** 修改支付应用状态 */
export function updateAppStatus(data: PayAppApi.UpdateStatusReq) {
export function updateAppStatus(data: PayAppApi.AppUpdateStatusReqVO) {
return requestClient.put('/pay/app/update-status', data);
}

22
apps/web-ele/src/api/pay/channel/index.ts
View File

@@ -1,5 +1,3 @@
import type { PageParam, PageResult } from '@vben/request';
import { requestClient } from '#/api/request';
export namespace PayChannelApi {
@@ -16,16 +14,6 @@ export namespace PayChannelApi {
}
}
/** 查询支付渠道列表 */
export function getChannelPage(params: PageParam) {
return requestClient.get<PageResult<PayChannelApi.Channel>>(
'/pay/channel/page',
{
params,
},
);
}
/** 查询支付渠道详情 */
export function getChannel(appId: number, code: string) {
return requestClient.get<PayChannelApi.Channel>('/pay/channel/get', {
@@ -42,13 +30,3 @@ export function createChannel(data: PayChannelApi.Channel) {
export function updateChannel(data: PayChannelApi.Channel) {
return requestClient.put('/pay/channel/update', data);
}
/** 删除支付渠道 */
export function deleteChannel(id: number) {
return requestClient.delete(`/pay/channel/delete?id=${id}`);
}
/** 导出支付渠道 */
export function exportChannel(params: PageParam) {
return requestClient.download('/pay/channel/export-excel', { params });
}

7
apps/web-ele/src/api/pay/demo/order/index.ts
View File

@@ -19,11 +19,6 @@ export namespace DemoOrderApi {
spuId?: number;
createTime?: Date;
}
export interface OrderPageReqVO extends PageParam {
spuId?: number;
createTime?: Date[];
}
}
/** 创建示例订单 */
@@ -32,7 +27,7 @@ export function createDemoOrder(data: DemoOrderApi.Order) {
}
/** 获得示例订单分页 */
export function getDemoOrderPage(params: DemoOrderApi.OrderPageReqVO) {
export function getDemoOrderPage(params: PageParam) {
return requestClient.get<PageResult<DemoOrderApi.Order>>(
'/pay/demo-order/page',
{

14
apps/web-ele/src/api/pay/notify/index.ts
View File

@@ -22,18 +22,6 @@ export namespace PayNotifyApi {
updateTime: Date;
logs?: any[];
}
/** 支付通知任务分页请求 */
export interface NotifyTaskPageReqVO extends PageParam {
appId?: number;
type?: number;
dataId?: number;
status?: number;
merchantOrderId?: string;
merchantRefundId?: string;
merchantTransferId?: string;
createTime?: Date[];
}
}
/** 获得支付通知明细 */
@@ -42,7 +30,7 @@ export function getNotifyTaskDetail(id: number) {
}
/** 获得支付通知分页 */
export function getNotifyTaskPage(params: PayNotifyApi.NotifyTaskPageReqVO) {
export function getNotifyTaskPage(params: PageParam) {
return requestClient.get<PageResult<PayNotifyApi.NotifyTask>>(
'/pay/notify/page',
{

13
apps/web-ele/src/api/pay/order/index.ts
View File

@@ -38,21 +38,10 @@ export namespace PayOrderApi {
createTime: Date;
updateTime: Date;
}
/** 支付订单分页请求 */
export interface OrderPageReqVO extends PageParam {
appId?: number;
channelCode?: string;
merchantOrderId?: string;
channelOrderNo?: string;
no?: string;
status?: number;
createTime?: Date[];
}
}
/** 查询支付订单列表 */
export function getOrderPage(params: PayOrderApi.OrderPageReqVO) {
export function getOrderPage(params: PageParam) {
return requestClient.get<PageResult<PayOrderApi.Order>>('/pay/order/page', {
params,
});

31
apps/web-ele/src/api/pay/refund/index.ts
View File

@@ -36,39 +36,10 @@ export namespace PayRefundApi {
createTime: Date;
updateTime: Date;
}
/** 退款订单分页请求 */
export interface RefundPageReqVO extends PageParam {
merchantId?: number;
appId?: number;
channelId?: number;
channelCode?: string;
orderId?: string;
tradeNo?: string;
merchantOrderId?: string;
merchantRefundNo?: string;
notifyUrl?: string;
notifyStatus?: number;
status?: number;
type?: number;
payAmount?: number;
refundAmount?: number;
reason?: string;
userIp?: string;
channelOrderNo?: string;
channelRefundNo?: string;
channelErrorCode?: string;
channelErrorMsg?: string;
channelExtras?: string;
expireTime?: Date[];
successTime?: Date[];
notifyTime?: Date[];
createTime?: Date[];
}
}
/** 查询退款订单列表 */
export function getRefundPage(params: PayRefundApi.RefundPageReqVO) {
export function getRefundPage(params: PageParam) {
return requestClient.get<PageResult<PayRefundApi.Refund>>(
'/pay/refund/page',
{

15
apps/web-ele/src/api/pay/transfer/index.ts
View File

@@ -25,23 +25,10 @@ export namespace PayTransferApi {
notifyUrl: string;
channelNotifyData: string;
}
/** 转账单分页请求 */
export interface TransferPageReqVO extends PageParam {
no?: string;
appId?: number;
channelCode?: string;
merchantOrderId?: string;
status?: number;
userName?: string;
userAccount?: string;
channelTransferNo?: string;
createTime?: Date[];
}
}
/** 查询转账单列表 */
export function getTransferPage(params: PayTransferApi.TransferPageReqVO) {
export function getTransferPage(params: PageParam) {
return requestClient.get<PageResult<PayTransferApi.Transfer>>(
'/pay/transfer/page',
{

24
apps/web-ele/src/api/pay/wallet/balance/index.ts
View File

@@ -3,11 +3,6 @@ import type { PageParam, PageResult } from '@vben/request';
import { requestClient } from '#/api/request';
export namespace PayWalletApi {
/** 用户钱包查询参数 */
export interface PayWalletUserReq {
userId: number;
}
/** 钱包信息 */
export interface Wallet {
id: number;
@@ -19,32 +14,27 @@ export namespace PayWalletApi {
freezePrice: number;
}
/** 钱包分页请求 */
export interface WalletPageReqVO extends PageParam {
userId?: number;
userType?: number;
balance?: number;
totalExpense?: number;
totalRecharge?: number;
freezePrice?: number;
/** 钱包查询参数 */
export interface WalletUserQueryReqVO {
userId: number;
}
/** 钱包修改余额 */
export interface PayWalletUpdateBalanceReqVO {
export interface WalletUpdateBalanceReqVO {
userId: number;
balance: number;
}
}
/** 查询用户钱包详情 */
export function getWallet(params: PayWalletApi.PayWalletUserReq) {
export function getWallet(params: PayWalletApi.WalletUserQueryReqVO) {
return requestClient.get<PayWalletApi.Wallet>('/pay/wallet/get', {
params,
});
}
/** 查询会员钱包列表 */
export function getWalletPage(params: PayWalletApi.WalletPageReqVO) {
export function getWalletPage(params: PageParam) {
return requestClient.get<PageResult<PayWalletApi.Wallet>>(
'/pay/wallet/page',
{
@@ -55,7 +45,7 @@ export function getWalletPage(params: PayWalletApi.WalletPageReqVO) {
/** 修改会员钱包余额 */
export function updateWalletBalance(
data: PayWalletApi.PayWalletUpdateBalanceReqVO,
data: PayWalletApi.WalletUpdateBalanceReqVO,
) {
return requestClient.put('/pay/wallet/update-balance', data);
}