@fxri/swagger2api 1.0.15 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,1673 +0,0 @@
1
- /** 明细详情 */
2
- export interface BatchPayLaunchDetailVo {
3
- /** 类型 */
4
- type: "0" | "1" | "2";
5
- /** 收款人银行卡卡号 */
6
- receiverAccount: string;
7
- /** 收款人 */
8
- receiverName: string;
9
- /**
10
- * 交易金额,单位:元,保留2位小数
11
- * @min 0.01
12
- * @exclusiveMin false
13
- * @max 1
14
- * @exclusiveMax false
15
- */
16
- amount: number;
17
- }
18
- export interface BatchPayLaunchReqVo {
19
- /** 批次号,25位随机字符串,不传时内部自动生成 */
20
- batchNo?: string;
21
- /**
22
- * 商户id(默认为登录的商户,其他商户需要权限)
23
- * @format int64
24
- */
25
- mchId?: number;
26
- /** 明细详情 */
27
- details?: BatchPayLaunchDetailVo[];
28
- }
29
- /** 返回数据 */
30
- export interface BatchPayLaunchRespVo {
31
- /** 批次号 */
32
- batchNo?: string;
33
- }
34
- /** 响应报文 */
35
- export interface ResponseMsgBatchPayLaunchRespVo {
36
- /**
37
- * 状态码
38
- * @format int32
39
- */
40
- code?: number;
41
- /** 错误提示 */
42
- msg?: string;
43
- /** 返回数据 */
44
- data?: BatchPayLaunchRespVo;
45
- }
46
- /** 商户创建 */
47
- export interface MerchantCreateReqVo {
48
- /** 商户名称 */
49
- name: string;
50
- }
51
- /** 商户列表 */
52
- export interface MerchantVo {
53
- /**
54
- * 商户id
55
- * @format int64
56
- */
57
- id?: number;
58
- /** 商户名称 */
59
- name?: string;
60
- /** 余额 */
61
- balance?: number;
62
- /**
63
- * 创建时间
64
- * @format date-time
65
- */
66
- createdAt?: string;
67
- /**
68
- * 最后更新时间
69
- * @format date-time
70
- */
71
- updatedAt?: string;
72
- /** 状态 */
73
- status?: "0" | "1" | "2";
74
- }
75
- /** 响应报文 */
76
- export interface ResponseMsgMerchantVo {
77
- /**
78
- * 状态码
79
- * @format int32
80
- */
81
- code?: number;
82
- /** 错误提示 */
83
- msg?: string;
84
- /** 商户列表 */
85
- data?: MerchantVo;
86
- }
87
- /** 商户 - 修改 */
88
- export interface MerchantBalanceUpdateReqVo {
89
- /**
90
- * 商户id
91
- * @format int64
92
- */
93
- mchId: number;
94
- /** 变动金额 */
95
- amount: number;
96
- /** 变动说明 */
97
- description: string;
98
- }
99
- /** 响应报文 */
100
- export interface ResponseMsgString {
101
- /**
102
- * 状态码
103
- * @format int32
104
- */
105
- code?: number;
106
- /** 错误提示 */
107
- msg?: string;
108
- /** 返回数据 */
109
- data?: string;
110
- }
111
- /** 更新商户管理员信息 */
112
- export interface MerchantAdminUpdateReqVo {
113
- /**
114
- * 商户管理员id(不填时为自己,修改他人需要额外权限)
115
- * @format int64
116
- */
117
- id?: number;
118
- /** 商户管理员名称 */
119
- name?: string;
120
- /** 手机号(仅修改他人可用) */
121
- phone?: string;
122
- /** 账号状态(仅修改他人可用) */
123
- status?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8";
124
- }
125
- /** 响应报文 */
126
- export interface ResponseMsgObject {
127
- /**
128
- * 状态码
129
- * @format int32
130
- */
131
- code?: number;
132
- /** 错误提示 */
133
- msg?: string;
134
- /** 返回数据 */
135
- data?: object;
136
- }
137
- export interface MerchantAdminUpdatePhoneReqVo {
138
- /** 新手机号码 */
139
- phone?: string;
140
- /** 短信验证码Key */
141
- captchaKey: string;
142
- /** 短信验证码 */
143
- captchaCode: string;
144
- }
145
- /** 商户登录 */
146
- export interface MerchantLoginPhoneReqVo {
147
- /** 手机号码 */
148
- phone: string;
149
- /** 短信验证码Key */
150
- captchaKey: string;
151
- /** 短信验证码 */
152
- captchaCode: string;
153
- }
154
- /** 管理员信息 */
155
- export interface MerchantAdminVo {
156
- /**
157
- * 商户管理员id
158
- * @format int64
159
- */
160
- id?: number;
161
- /**
162
- * 关联的商户id
163
- * @format int64
164
- */
165
- mchId?: number;
166
- /** 管理员名称 */
167
- name?: string;
168
- /** 描述 */
169
- description?: string;
170
- /** 状态 */
171
- status?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8";
172
- /**
173
- * 创建时间
174
- * @format date-time
175
- */
176
- createdAt?: string;
177
- /**
178
- * 最后更新时间
179
- * @format date-time
180
- */
181
- updatedAt?: string;
182
- }
183
- /** 商户管理员登录 返回响应 */
184
- export interface MerchantLoginRespVo {
185
- /** 登录token */
186
- token?: string;
187
- /** 管理员信息 */
188
- info?: MerchantAdminVo;
189
- }
190
- /** 响应报文 */
191
- export interface ResponseMsgMerchantLoginRespVo {
192
- /**
193
- * 状态码
194
- * @format int32
195
- */
196
- code?: number;
197
- /** 错误提示 */
198
- msg?: string;
199
- /** 商户管理员登录 返回响应 */
200
- data?: MerchantLoginRespVo;
201
- }
202
- /** 创建商户管理员 */
203
- export interface MerchantAdminCreateReqVo {
204
- /**
205
- * 关联的商户id(不传为自己商户,创建其他商户管理员需要权限)
206
- * @format int64
207
- */
208
- mchId?: number;
209
- /** 商户管理员名称 */
210
- name: string;
211
- /** 商户管理员描述 */
212
- description?: string;
213
- /** 商户管理员手机号 */
214
- phone: string;
215
- }
216
- /** 响应报文 */
217
- export interface ResponseMsgMerchantAdminVo {
218
- /**
219
- * 状态码
220
- * @format int32
221
- */
222
- code?: number;
223
- /** 错误提示 */
224
- msg?: string;
225
- /** 管理员信息 */
226
- data?: MerchantAdminVo;
227
- }
228
- /** 汇聚支付- 转账发起请求 */
229
- export interface JpTransferLaunchReqVo {
230
- /** 订单号,25位随机字符串,不传时内部自动生成 */
231
- orderNo?: string;
232
- /** 转账类型 */
233
- type: "0" | "10" | "11" | "12" | "20" | "21";
234
- /** 发起方 */
235
- sourceMchNo: string;
236
- /** 接收方 */
237
- targetMchNo: string;
238
- /**
239
- * 金额,单位元,精确2位小数
240
- * @min 0.01
241
- * @exclusiveMin false
242
- */
243
- amount: number;
244
- }
245
- /** 转账流水 */
246
- export interface JpTransferRespVo {
247
- /**
248
- * 转账id
249
- * @format int64
250
- */
251
- id?: number;
252
- /**
253
- * 商户号
254
- * @format int64
255
- */
256
- mchNo?: number;
257
- /** 订单号 */
258
- orderNo?: string;
259
- /** 批次号 */
260
- batchNo?: string;
261
- /** 流水号 */
262
- trxNo?: string;
263
- /** 转账类型 */
264
- type?: "0" | "10" | "11" | "12" | "20" | "21";
265
- /** 金额,不含手续费 */
266
- amount?: number;
267
- /** 手续费 */
268
- fee?: number;
269
- /** 发方姓名 */
270
- sourceName?: string;
271
- /** 发方账户 */
272
- sourceAccount?: string;
273
- /** 收方姓名 */
274
- targetName?: string;
275
- /** 收方账户 */
276
- targetAccount?: string;
277
- /** 回单下载地址 */
278
- voucherUrl?: string;
279
- /** 转账备注 */
280
- remark?: string;
281
- /** 错误描述 */
282
- errorDesc?: string;
283
- /**
284
- * 创建时间
285
- * @format date-time
286
- */
287
- createdAt?: string;
288
- /**
289
- * 完成时间
290
- * @format date-time
291
- */
292
- completeAt?: string;
293
- /** 状态 */
294
- status?: "0" | "1" | "2" | "3" | "10" | "11";
295
- }
296
- /** 响应报文 */
297
- export interface ResponseMsgJpTransferRespVo {
298
- /**
299
- * 状态码
300
- * @format int32
301
- */
302
- code?: number;
303
- /** 错误提示 */
304
- msg?: string;
305
- /** 转账流水 */
306
- data?: JpTransferRespVo;
307
- }
308
- /** 汇聚支付- 支付明细详情 */
309
- export interface JpBatchPayDetail {
310
- /** 类型 */
311
- type: "0" | "10" | "11" | "12" | "20" | "21";
312
- /** 收款人银行卡卡号 */
313
- receiverAccount: string;
314
- /** 收款人 */
315
- receiverName: string;
316
- /**
317
- * 交易金额,单位:元,保留2位小数
318
- * @min 0.01
319
- * @exclusiveMin false
320
- * @max 1
321
- * @exclusiveMax false
322
- */
323
- amount: number;
324
- }
325
- /** 汇聚支付- 批量代付发起请求 */
326
- export interface JpBatchPayLaunchRequest {
327
- /** 批次号,25位随机字符串,不传时内部自动生成 */
328
- batchNo?: string;
329
- /** 付款商户号 */
330
- sourceMchNo?: string;
331
- /** 明细数据 */
332
- details: JpBatchPayDetail[];
333
- }
334
- /** 汇聚支付- 批量代付结果响应 */
335
- export interface JpBatchPayRespVo {
336
- /**
337
- * 批量代付id
338
- * @format int64
339
- */
340
- id?: number;
341
- /** 批次号 */
342
- batchNo?: string;
343
- /**
344
- * 总笔数
345
- * @format int64
346
- */
347
- totalCount?: number;
348
- /** 总金额 */
349
- totalAmount?: number;
350
- /**
351
- * 成功笔数
352
- * @format int64
353
- */
354
- successCount?: number;
355
- /** 成功金额 */
356
- successAmount?: number;
357
- /**
358
- * 失败笔数
359
- * @format int64
360
- */
361
- failCount?: number;
362
- /** 失败金额 */
363
- failAmount?: number;
364
- /** 成功的总手续费 */
365
- feeSum?: number;
366
- /** 错误描述 */
367
- errorDesc?: string;
368
- /** 状态 */
369
- status?: "0" | "1" | "2" | "3" | "10" | "11" | "12" | "13" | "14" | "15" | "99";
370
- /**
371
- * 创建时间
372
- * @format date-time
373
- */
374
- createdAt?: string;
375
- /**
376
- * 完成时间,所有明细处理完成
377
- * @format date-time
378
- */
379
- completeAt?: string;
380
- }
381
- /** 响应报文 */
382
- export interface ResponseMsgJpBatchPayRespVo {
383
- /**
384
- * 状态码
385
- * @format int32
386
- */
387
- code?: number;
388
- /** 错误提示 */
389
- msg?: string;
390
- /** 汇聚支付- 批量代付结果响应 */
391
- data?: JpBatchPayRespVo;
392
- }
393
- /** 返回数据 */
394
- export interface ExternalReqVo {
395
- /** 应用id */
396
- appId: string;
397
- /** 随机字符串,推荐UUID */
398
- nonce: string;
399
- /**
400
- * 时间戳,13位毫秒级
401
- * @format int64
402
- */
403
- timestamp: number;
404
- /** 签名 */
405
- sign: string;
406
- /** 方法名 */
407
- method: string;
408
- /** 数据 */
409
- data?: object;
410
- }
411
- /** 响应报文 */
412
- export interface ResponseMsgExternalReqVo {
413
- /**
414
- * 状态码
415
- * @format int32
416
- */
417
- code?: number;
418
- /** 错误提示 */
419
- msg?: string;
420
- /** 返回数据 */
421
- data?: ExternalReqVo;
422
- }
423
- /** 验证码 - 短信验证码发送 */
424
- export interface CaptchaSmsSendReqVo {
425
- /** 接收验证码的手机号 */
426
- phone: string;
427
- /** 图片验证码Key */
428
- imageKey: string;
429
- /** 图片验证码值 */
430
- imageCode: string;
431
- }
432
- /** 验证码 - 短信验证码发送 */
433
- export interface CaptchaSmsSendRespVo {
434
- /** 接收验证码的手机号 */
435
- phone: string;
436
- /** 验证码Key */
437
- captchaKey: string;
438
- }
439
- /** 响应报文 */
440
- export interface ResponseMsgCaptchaSmsSendRespVo {
441
- /**
442
- * 状态码
443
- * @format int32
444
- */
445
- code?: number;
446
- /** 错误提示 */
447
- msg?: string;
448
- /** 验证码 - 短信验证码发送 */
449
- data?: CaptchaSmsSendRespVo;
450
- }
451
- /** 管理员 - 修改参数 */
452
- export interface AdminUpdateReqVo {
453
- /**
454
- * 管理员id(不填时为自己,修改他人需要额外权限)
455
- * @format int64
456
- */
457
- id?: number;
458
- /** 名称 */
459
- name?: string;
460
- /** 手机号(仅修改他人可用) */
461
- phone?: string;
462
- /** 账户状态(仅修改他人可用) */
463
- status?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8";
464
- }
465
- export interface AdminUpdatePhoneReqVo {
466
- /** 新手机号码 */
467
- phone?: string;
468
- /** 短信验证码Key */
469
- captchaKey: string;
470
- /** 短信验证码 */
471
- captchaCode: string;
472
- }
473
- /** 管理员 - 登录参数 */
474
- export interface AdminLoginReqVo {
475
- /** 手机号码 */
476
- phone: string;
477
- /** 短信验证码Key */
478
- captchaKey: string;
479
- /** 短信验证码 */
480
- captchaCode: string;
481
- }
482
- /** 管理员 - 登录请求响应 */
483
- export interface AdminLoginRespVo {
484
- /** 登录token */
485
- token?: string;
486
- /** 管理员信息 */
487
- info?: AdminVo;
488
- }
489
- /** 管理员信息 */
490
- export interface AdminVo {
491
- /**
492
- * 管理员id
493
- * @format int64
494
- */
495
- id?: number;
496
- /** 名称 */
497
- name?: string;
498
- /** 手机号码 */
499
- phone?: string;
500
- /** 状态 */
501
- status?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8";
502
- }
503
- /** 响应报文 */
504
- export interface ResponseMsgAdminLoginRespVo {
505
- /**
506
- * 状态码
507
- * @format int32
508
- */
509
- code?: number;
510
- /** 错误提示 */
511
- msg?: string;
512
- /** 管理员 - 登录请求响应 */
513
- data?: AdminLoginRespVo;
514
- }
515
- export interface AdminCreateReqVo {
516
- /** 管理员名称 */
517
- name: string;
518
- /** 描述 */
519
- description?: string;
520
- /** 手机号码 */
521
- phone: string;
522
- }
523
- /** 响应报文 */
524
- export interface ResponseMsgAdminVo {
525
- /**
526
- * 状态码
527
- * @format int32
528
- */
529
- code?: number;
530
- /** 错误提示 */
531
- msg?: string;
532
- /** 管理员信息 */
533
- data?: AdminVo;
534
- }
535
- /** 批付列表 */
536
- export interface BatchPayListReqVo {
537
- /**
538
- * 当前页,起始为1
539
- * @format int32
540
- * @min 1
541
- */
542
- pageNum?: number;
543
- /**
544
- * 每页数据数量,范围1-500条
545
- * @format int32
546
- * @min 1
547
- * @max 500
548
- */
549
- pageSize?: number;
550
- /**
551
- * 商户id,(指定商户需要权限)
552
- * @format int64
553
- */
554
- mchId?: number;
555
- /** 批次号 */
556
- batchNo?: string;
557
- /** 批次状态 */
558
- status?: "0" | "1" | "2" | "3" | "10" | "11" | "12" | "13" | "14" | "15" | "99";
559
- /**
560
- * 创建时间区间开始,yyyy-MM-dd HH:mm:ss
561
- * @format date-time
562
- */
563
- startTime?: string;
564
- /**
565
- * 创建时间区间结束, yyyy-MM-dd HH:mm:ss
566
- * @format date-time
567
- */
568
- endTime?: string;
569
- }
570
- /** 分页结果 */
571
- export interface PageDataJpBatchPayRespVo {
572
- /**
573
- * 总记录数
574
- * @format int64
575
- */
576
- total?: number;
577
- /** 列表数据 */
578
- rows?: JpBatchPayRespVo[];
579
- /**
580
- * 当前页记录数
581
- * @format int64
582
- */
583
- size?: number;
584
- /**
585
- * 当前页
586
- * @format int64
587
- */
588
- current?: number;
589
- }
590
- /** 响应报文 */
591
- export interface ResponseMsgPageDataJpBatchPayRespVo {
592
- /**
593
- * 状态码
594
- * @format int32
595
- */
596
- code?: number;
597
- /** 错误提示 */
598
- msg?: string;
599
- /** 分页结果 */
600
- data?: PageDataJpBatchPayRespVo;
601
- }
602
- /** 批付查询 */
603
- export interface BatchPayReqVo {
604
- /**
605
- * 当前页,起始为1
606
- * @format int32
607
- * @min 1
608
- */
609
- pageNum?: number;
610
- /**
611
- * 每页数据数量,范围1-500条
612
- * @format int32
613
- * @min 1
614
- * @max 500
615
- */
616
- pageSize?: number;
617
- /**
618
- * 批付id
619
- * @format int64
620
- */
621
- batchId?: number;
622
- /** 批付号(与批付id,二选一即可) */
623
- batchNo?: string;
624
- }
625
- /** 响应报文 */
626
- export interface ResponseMsgListTransferRespVo {
627
- /**
628
- * 状态码
629
- * @format int32
630
- */
631
- code?: number;
632
- /** 错误提示 */
633
- msg?: string;
634
- /** 返回数据 */
635
- data?: TransferRespVo[];
636
- }
637
- /** 转账记录 */
638
- export interface TransferRespVo {
639
- /**
640
- * 转账id
641
- * @format int64
642
- */
643
- id?: number;
644
- /** 订单号 */
645
- orderNo?: string;
646
- /** 批次号 */
647
- batchNo?: string;
648
- /** 流水号 */
649
- trxNo?: string;
650
- /** 转账类型 */
651
- type?: "0" | "10" | "11" | "12" | "20" | "21";
652
- /** 金额,不含手续费 */
653
- amount?: number;
654
- /** 手续费 */
655
- fee?: number;
656
- /** 发方姓名 */
657
- sourceName?: string;
658
- /** 收方姓名 */
659
- targetName?: string;
660
- /** 收方账户 */
661
- targetAccount?: string;
662
- /** 回单下载地址 */
663
- voucherUrl?: string;
664
- /** 转账备注 */
665
- remark?: string;
666
- /** 错误描述 */
667
- errorDesc?: string;
668
- /**
669
- * 创建时间
670
- * @format date-time
671
- */
672
- createdAt?: string;
673
- /**
674
- * 完成时间
675
- * @format date-time
676
- */
677
- completeAt?: string;
678
- /** 状态 */
679
- status?: "0" | "1" | "2" | "3" | "10" | "11";
680
- }
681
- /** 商户列表 */
682
- export interface MerchantListReqVo {
683
- /**
684
- * 当前页,起始为1
685
- * @format int32
686
- * @min 1
687
- */
688
- pageNum?: number;
689
- /**
690
- * 每页数据数量,范围1-500条
691
- * @format int32
692
- * @min 1
693
- * @max 500
694
- */
695
- pageSize?: number;
696
- /** 商户名称 */
697
- mchName?: string;
698
- /** 商户状态 */
699
- status?: "0" | "1" | "2";
700
- }
701
- /** 分页结果 */
702
- export interface PageDataMerchantVo {
703
- /**
704
- * 总记录数
705
- * @format int64
706
- */
707
- total?: number;
708
- /** 列表数据 */
709
- rows?: MerchantVo[];
710
- /**
711
- * 当前页记录数
712
- * @format int64
713
- */
714
- size?: number;
715
- /**
716
- * 当前页
717
- * @format int64
718
- */
719
- current?: number;
720
- }
721
- /** 响应报文 */
722
- export interface ResponseMsgPageDataMerchantVo {
723
- /**
724
- * 状态码
725
- * @format int32
726
- */
727
- code?: number;
728
- /** 错误提示 */
729
- msg?: string;
730
- /** 分页结果 */
731
- data?: PageDataMerchantVo;
732
- }
733
- export interface MerchantBalanceLogReqVo {
734
- /**
735
- * 当前页,起始为1
736
- * @format int32
737
- * @min 1
738
- */
739
- pageNum?: number;
740
- /**
741
- * 每页数据数量,范围1-500条
742
- * @format int32
743
- * @min 1
744
- * @max 500
745
- */
746
- pageSize?: number;
747
- /**
748
- * 商户id
749
- * @format int64
750
- */
751
- mchId: number;
752
- }
753
- /** 列表数据 */
754
- export interface MerchantBalanceLogRespVo {
755
- /** 原余额 */
756
- oldBalance?: number;
757
- /** 新余额 */
758
- newBalance?: number;
759
- /** 变动金额 */
760
- amount?: number;
761
- /** 描述 */
762
- description?: string;
763
- /**
764
- * 创建时间
765
- * @format date-time
766
- */
767
- createdAt?: string;
768
- }
769
- /** 分页结果 */
770
- export interface PageDataMerchantBalanceLogRespVo {
771
- /**
772
- * 总记录数
773
- * @format int64
774
- */
775
- total?: number;
776
- /** 列表数据 */
777
- rows?: MerchantBalanceLogRespVo[];
778
- /**
779
- * 当前页记录数
780
- * @format int64
781
- */
782
- size?: number;
783
- /**
784
- * 当前页
785
- * @format int64
786
- */
787
- current?: number;
788
- }
789
- /** 响应报文 */
790
- export interface ResponseMsgPageDataMerchantBalanceLogRespVo {
791
- /**
792
- * 状态码
793
- * @format int32
794
- */
795
- code?: number;
796
- /** 错误提示 */
797
- msg?: string;
798
- /** 分页结果 */
799
- data?: PageDataMerchantBalanceLogRespVo;
800
- }
801
- /** 商户管理员列表 */
802
- export interface MerchantAdminListReqVo {
803
- /**
804
- * 当前页,起始为1
805
- * @format int32
806
- * @min 1
807
- */
808
- pageNum?: number;
809
- /**
810
- * 每页数据数量,范围1-500条
811
- * @format int32
812
- * @min 1
813
- * @max 500
814
- */
815
- pageSize?: number;
816
- /**
817
- * 商户id
818
- * @format int64
819
- */
820
- mchId?: number;
821
- /** 商户管理员名称 */
822
- name?: string;
823
- /** 手机号码 */
824
- phone?: string;
825
- }
826
- /** 分页结果 */
827
- export interface PageDataMerchantAdminVo {
828
- /**
829
- * 总记录数
830
- * @format int64
831
- */
832
- total?: number;
833
- /** 列表数据 */
834
- rows?: MerchantAdminVo[];
835
- /**
836
- * 当前页记录数
837
- * @format int64
838
- */
839
- size?: number;
840
- /**
841
- * 当前页
842
- * @format int64
843
- */
844
- current?: number;
845
- }
846
- /** 响应报文 */
847
- export interface ResponseMsgPageDataMerchantAdminVo {
848
- /**
849
- * 状态码
850
- * @format int32
851
- */
852
- code?: number;
853
- /** 错误提示 */
854
- msg?: string;
855
- /** 分页结果 */
856
- data?: PageDataMerchantAdminVo;
857
- }
858
- /** 汇聚支付- 转账列表响应 */
859
- export interface JpTransferListReqVo {
860
- /**
861
- * 当前页,起始为1
862
- * @format int32
863
- * @min 1
864
- */
865
- pageNum?: number;
866
- /**
867
- * 每页数据数量,范围1-500条
868
- * @format int32
869
- * @min 1
870
- * @max 500
871
- */
872
- pageSize?: number;
873
- /**
874
- * 转账id
875
- * @format int64
876
- */
877
- id?: number;
878
- /** 商户号 */
879
- mchNo?: string;
880
- /** 批次号 */
881
- batchNo?: string;
882
- /** 类型 */
883
- type?: "0" | "10" | "11" | "12" | "20" | "21";
884
- /** 订单号 */
885
- orderNo?: string;
886
- /** 流水号 */
887
- trxNo?: string;
888
- /** 收款人姓名 */
889
- receiverName?: string;
890
- /** 收款人银行卡卡号 */
891
- receiverAccount?: string;
892
- /** 状态 */
893
- status?: "0" | "1" | "2" | "3" | "10" | "11";
894
- /**
895
- * 创建时间区间开始,yyyy-MM-dd HH:mm:ss
896
- * @format date-time
897
- */
898
- startTime?: string;
899
- /**
900
- * 创建时间区间结束, yyyy-MM-dd HH:mm:ss
901
- * @format date-time
902
- */
903
- endTime?: string;
904
- }
905
- /** 分页结果 */
906
- export interface PageDataJpTransferRespVo {
907
- /**
908
- * 总记录数
909
- * @format int64
910
- */
911
- total?: number;
912
- /** 列表数据 */
913
- rows?: JpTransferRespVo[];
914
- /**
915
- * 当前页记录数
916
- * @format int64
917
- */
918
- size?: number;
919
- /**
920
- * 当前页
921
- * @format int64
922
- */
923
- current?: number;
924
- }
925
- /** 响应报文 */
926
- export interface ResponseMsgPageDataJpTransferRespVo {
927
- /**
928
- * 状态码
929
- * @format int32
930
- */
931
- code?: number;
932
- /** 错误提示 */
933
- msg?: string;
934
- /** 分页结果 */
935
- data?: PageDataJpTransferRespVo;
936
- }
937
- /** 汇聚支付- 批量代付列表查询 */
938
- export interface JpBatchPayListReqVo {
939
- /**
940
- * 当前页,起始为1
941
- * @format int32
942
- * @min 1
943
- */
944
- pageNum?: number;
945
- /**
946
- * 每页数据数量,范围1-500条
947
- * @format int32
948
- * @min 1
949
- * @max 500
950
- */
951
- pageSize?: number;
952
- /**
953
- * 批量代付id
954
- * @format int64
955
- */
956
- id?: number;
957
- /** 商户号 */
958
- mchNo?: string;
959
- /** 批次号 */
960
- batchNo?: string;
961
- /** 状态 */
962
- status?: "0" | "1" | "2" | "3" | "10" | "11" | "12" | "13" | "14" | "15" | "99";
963
- /**
964
- * 创建时间区间开始,yyyy-MM-dd HH:mm:ss
965
- * @format date-time
966
- */
967
- startTime?: string;
968
- /**
969
- * 创建时间区间结束, yyyy-MM-dd HH:mm:ss
970
- * @format date-time
971
- */
972
- endTime?: string;
973
- }
974
- /** 商户分页 参数 */
975
- export interface JpMerchantPageQuery {
976
- /**
977
- * 当前页,起始为1
978
- * @format int32
979
- * @min 1
980
- */
981
- pageNum?: number;
982
- /**
983
- * 每页数据数量,范围1-500条
984
- * @format int32
985
- * @min 1
986
- * @max 500
987
- */
988
- pageSize?: number;
989
- }
990
- /** 商户 */
991
- export interface JpMerchantRespVo {
992
- /**
993
- * 商户id
994
- * @format int64
995
- */
996
- id?: number;
997
- /** 商户号 */
998
- mchNo?: string;
999
- /** 商户分类,如分账户、二级商户 */
1000
- category?: "0" | "1" | "2" | "3";
1001
- /** 商户名称 */
1002
- name?: string;
1003
- /** 商户简称 */
1004
- shortName?: string;
1005
- /** 登录名 */
1006
- loginName?: string;
1007
- /** 类型,如个人、个体、企业 */
1008
- type?: "10" | "11" | "12";
1009
- /** 业务联系人姓名 */
1010
- busiContactName?: string;
1011
- /** 业务联系人手机号 */
1012
- busiContactPhone?: string;
1013
- /** 法人姓名 */
1014
- legalName?: string;
1015
- /** 法人手机号码 */
1016
- legalPhone?: string;
1017
- /** 法人身份证号码 */
1018
- legalId?: string;
1019
- /**
1020
- * 法人身份证过期时间
1021
- * @format date-time
1022
- */
1023
- legalIdExpiry?: string;
1024
- /** 营业执照编号 */
1025
- licenseNo?: string;
1026
- /**
1027
- * 营业执照过期时间
1028
- * @format date-time
1029
- */
1030
- licenseExpiry?: string;
1031
- /** 经营范围 */
1032
- manageScope?: string;
1033
- /** 经营地址 */
1034
- manageAddr?: string;
1035
- /** 结算方式 */
1036
- settMode?: "0" | "1" | "2" | "3" | "4";
1037
- /** 结算周期类型 */
1038
- settDateType?: "0" | "1" | "2" | "3";
1039
- /**
1040
- * 结算周期
1041
- * @format int32
1042
- */
1043
- riskDay?: number;
1044
- /** 结算账户类型 */
1045
- bankType?: "0" | "1" | "2";
1046
- /** 银行账号名称 */
1047
- bankName?: string;
1048
- /** 银行账号 */
1049
- bankNo?: string;
1050
- /** 联行号 */
1051
- bankChannelNo?: string;
1052
- /** 状态 */
1053
- status?: "0" | "1" | "2" | "3";
1054
- /**
1055
- * 创建时间
1056
- * @format date-time
1057
- */
1058
- createdAt?: string;
1059
- }
1060
- /** 分页结果 */
1061
- export interface PageDataJpMerchantRespVo {
1062
- /**
1063
- * 总记录数
1064
- * @format int64
1065
- */
1066
- total?: number;
1067
- /** 列表数据 */
1068
- rows?: JpMerchantRespVo[];
1069
- /**
1070
- * 当前页记录数
1071
- * @format int64
1072
- */
1073
- size?: number;
1074
- /**
1075
- * 当前页
1076
- * @format int64
1077
- */
1078
- current?: number;
1079
- }
1080
- /** 响应报文 */
1081
- export interface ResponseMsgPageDataJpMerchantRespVo {
1082
- /**
1083
- * 状态码
1084
- * @format int32
1085
- */
1086
- code?: number;
1087
- /** 错误提示 */
1088
- msg?: string;
1089
- /** 分页结果 */
1090
- data?: PageDataJpMerchantRespVo;
1091
- }
1092
- /** 枚举列表请求参数 */
1093
- export interface EnumListReqVo {
1094
- /** id集合,多个请用,隔开 */
1095
- ids?: string;
1096
- }
1097
- /** 枚举项 */
1098
- export interface EnumItemVo {
1099
- /** 枚举键值 */
1100
- code?: object;
1101
- /** 枚举描述 */
1102
- desc?: string;
1103
- }
1104
- /** 枚举信息 */
1105
- export interface EnumVo {
1106
- /** 枚举名称 */
1107
- id?: string;
1108
- /** 枚举名字 */
1109
- name?: string;
1110
- values?: EnumItemVo[];
1111
- }
1112
- /** 响应报文 */
1113
- export interface ResponseMsgListEnumVo {
1114
- /**
1115
- * 状态码
1116
- * @format int32
1117
- */
1118
- code?: number;
1119
- /** 错误提示 */
1120
- msg?: string;
1121
- /** 返回数据 */
1122
- data?: EnumVo[];
1123
- }
1124
- /** 图像验证码 */
1125
- export interface CaptchaImageVo {
1126
- /** 图像验证码Key */
1127
- key?: string;
1128
- /** 图像验证码图片,data:image/jpeg;base64 */
1129
- dataUrl?: string;
1130
- }
1131
- /** 响应报文 */
1132
- export interface ResponseMsgCaptchaImageVo {
1133
- /**
1134
- * 状态码
1135
- * @format int32
1136
- */
1137
- code?: number;
1138
- /** 错误提示 */
1139
- msg?: string;
1140
- /** 图像验证码 */
1141
- data?: CaptchaImageVo;
1142
- }
1143
- export interface AdminListReqVo {
1144
- /**
1145
- * 当前页,起始为1
1146
- * @format int32
1147
- * @min 1
1148
- */
1149
- pageNum?: number;
1150
- /**
1151
- * 每页数据数量,范围1-500条
1152
- * @format int32
1153
- * @min 1
1154
- * @max 500
1155
- */
1156
- pageSize?: number;
1157
- /**
1158
- * 管理员id
1159
- * @format int64
1160
- */
1161
- id?: number;
1162
- /** 管理员名称 */
1163
- name?: string;
1164
- /** 手机号 */
1165
- phone?: string;
1166
- /** 状态 */
1167
- status?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8";
1168
- }
1169
- /** 分页结果 */
1170
- export interface PageDataAdminVo {
1171
- /**
1172
- * 总记录数
1173
- * @format int64
1174
- */
1175
- total?: number;
1176
- /** 列表数据 */
1177
- rows?: AdminVo[];
1178
- /**
1179
- * 当前页记录数
1180
- * @format int64
1181
- */
1182
- size?: number;
1183
- /**
1184
- * 当前页
1185
- * @format int64
1186
- */
1187
- current?: number;
1188
- }
1189
- /** 响应报文 */
1190
- export interface ResponseMsgPageDataAdminVo {
1191
- /**
1192
- * 状态码
1193
- * @format int32
1194
- */
1195
- code?: number;
1196
- /** 错误提示 */
1197
- msg?: string;
1198
- /** 分页结果 */
1199
- data?: PageDataAdminVo;
1200
- }
1201
- import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
1202
- export type QueryParamsType = Record<string | number, any>;
1203
- export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
1204
- /** set parameter to `true` for call `securityWorker` for this request */
1205
- secure?: boolean;
1206
- /** request path */
1207
- path: string;
1208
- /** content type of request body */
1209
- type?: ContentType;
1210
- /** query params */
1211
- query?: QueryParamsType;
1212
- /** format of response (i.e. response.json() -> format: "json") */
1213
- format?: ResponseType;
1214
- /** request body */
1215
- body?: unknown;
1216
- }
1217
- export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
1218
- export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
1219
- securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
1220
- secure?: boolean;
1221
- format?: ResponseType;
1222
- }
1223
- export declare enum ContentType {
1224
- Json = "application/json",
1225
- JsonApi = "application/vnd.api+json",
1226
- FormData = "multipart/form-data",
1227
- UrlEncoded = "application/x-www-form-urlencoded",
1228
- Text = "text/plain"
1229
- }
1230
- export declare class HttpClient<SecurityDataType = unknown> {
1231
- instance: AxiosInstance;
1232
- private securityData;
1233
- private securityWorker?;
1234
- private secure?;
1235
- private format?;
1236
- constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
1237
- setSecurityData: (data: SecurityDataType | null) => void;
1238
- protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
1239
- protected stringifyFormItem(formItem: unknown): string;
1240
- protected createFormData(input: Record<string, unknown>): FormData;
1241
- request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T>>;
1242
- }
1243
- /**
1244
- * @title 凯聚通支付平台
1245
- * @version v1.0
1246
- * @baseUrl https://kjt.yunhesoft.top/api/admin
1247
- * @contact 云鹤软件 <admin@yunhesoft.top>
1248
- *
1249
- * 凯聚通支付平台后端API文档
1250
- */
1251
- export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
1252
- transaction: {
1253
- /**
1254
- * No description
1255
- *
1256
- * @tags 商户交易模块
1257
- * @name BatchPayLaunchPost
1258
- * @summary 发起批付
1259
- * @request POST:/transaction/batch-pay/launch
1260
- * @response `200` `ResponseMsgBatchPayLaunchRespVo` OK
1261
- */
1262
- batchPayLaunchPost: (data: BatchPayLaunchReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgBatchPayLaunchRespVo, any, {}>>;
1263
- /**
1264
- * No description
1265
- *
1266
- * @tags 商户交易模块
1267
- * @name BatchPayListGet
1268
- * @summary 获取当前商户的批付列表,(指定商户时需要权限)
1269
- * @request GET:/transaction/batch-pay/list
1270
- * @response `200` `ResponseMsgPageDataJpBatchPayRespVo` OK
1271
- */
1272
- batchPayListGet: (query: {
1273
- /** 批付列表 */
1274
- param: BatchPayListReqVo;
1275
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgPageDataJpBatchPayRespVo, any, {}>>;
1276
- /**
1277
- * No description
1278
- *
1279
- * @tags 商户交易模块
1280
- * @name BatchPayGetGet
1281
- * @summary 获取批付详情
1282
- * @request GET:/transaction/batch-pay/get
1283
- * @response `200` `ResponseMsgListTransferRespVo` OK
1284
- */
1285
- batchPayGetGet: (query: {
1286
- /** 批付查询 */
1287
- param: BatchPayReqVo;
1288
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgListTransferRespVo, any, {}>>;
1289
- };
1290
- merchant: {
1291
- /**
1292
- * No description
1293
- *
1294
- * @tags 商户模块
1295
- * @name CreatePost
1296
- * @summary 创建商户
1297
- * @request POST:/merchant/create
1298
- * @response `200` `ResponseMsgMerchantVo` OK
1299
- */
1300
- createPost: (data: MerchantCreateReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgMerchantVo, any, {}>>;
1301
- /**
1302
- * No description
1303
- *
1304
- * @tags 商户模块
1305
- * @name BalanceUpdatePost
1306
- * @summary 修改商户余额
1307
- * @request POST:/merchant/balance/update
1308
- * @response `200` `ResponseMsgString` OK
1309
- */
1310
- balanceUpdatePost: (data: MerchantBalanceUpdateReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgString, any, {}>>;
1311
- /**
1312
- * No description
1313
- *
1314
- * @tags 商户管理员模块
1315
- * @name AdminUpdatePost
1316
- * @summary 修改商户管理员信息
1317
- * @request POST:/merchant/admin/update
1318
- * @response `200` `ResponseMsgObject` OK
1319
- */
1320
- adminUpdatePost: (query: {
1321
- /** 更新商户管理员信息 */
1322
- param: MerchantAdminUpdateReqVo;
1323
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgObject, any, {}>>;
1324
- /**
1325
- * No description
1326
- *
1327
- * @tags 商户管理员模块
1328
- * @name AdminUpdatePhonePost
1329
- * @summary 修改商户管理员手机号
1330
- * @request POST:/merchant/admin/update/phone
1331
- * @response `200` `ResponseMsgString` OK
1332
- */
1333
- adminUpdatePhonePost: (data: MerchantAdminUpdatePhoneReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgString, any, {}>>;
1334
- /**
1335
- * @description 登出当前登录的商户管理员
1336
- *
1337
- * @tags 商户管理员模块
1338
- * @name AdminLogoutPost
1339
- * @summary 登出
1340
- * @request POST:/merchant/admin/logout
1341
- * @response `200` `ResponseMsgString` OK
1342
- */
1343
- adminLogoutPost: (params?: RequestParams) => Promise<AxiosResponse<ResponseMsgString, any, {}>>;
1344
- /**
1345
- * No description
1346
- *
1347
- * @tags 商户管理员模块
1348
- * @name AdminLoginPhonePost
1349
- * @summary 登录
1350
- * @request POST:/merchant/admin/login/phone
1351
- * @response `200` `ResponseMsgMerchantLoginRespVo` OK
1352
- */
1353
- adminLoginPhonePost: (data: MerchantLoginPhoneReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgMerchantLoginRespVo, any, {}>>;
1354
- /**
1355
- * No description
1356
- *
1357
- * @tags 商户管理员模块
1358
- * @name AdminCreatePost
1359
- * @summary 创建商户管理员
1360
- * @request POST:/merchant/admin/create
1361
- * @response `200` `ResponseMsgMerchantAdminVo` OK
1362
- */
1363
- adminCreatePost: (data: MerchantAdminCreateReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgMerchantAdminVo, any, {}>>;
1364
- /**
1365
- * No description
1366
- *
1367
- * @tags 商户模块
1368
- * @name ListGet
1369
- * @summary 获取商户列表
1370
- * @request GET:/merchant/list
1371
- * @response `200` `ResponseMsgPageDataMerchantVo` OK
1372
- */
1373
- listGet: (query: {
1374
- /** 商户列表 */
1375
- param: MerchantListReqVo;
1376
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgPageDataMerchantVo, any, {}>>;
1377
- /**
1378
- * No description
1379
- *
1380
- * @tags 商户模块
1381
- * @name GetGet
1382
- * @summary 获取商户信息 (指定获取需要权限)
1383
- * @request GET:/merchant/get
1384
- * @response `200` `ResponseMsgMerchantVo` OK
1385
- */
1386
- getGet: (query?: {
1387
- /**
1388
- * @format int64
1389
- * @default -1
1390
- */
1391
- id?: number;
1392
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgMerchantVo, any, {}>>;
1393
- /**
1394
- * No description
1395
- *
1396
- * @tags 商户模块
1397
- * @name BalanceLogGetGet
1398
- * @summary 获取商户余额变动记录
1399
- * @request GET:/merchant/balance/log/get
1400
- * @response `200` `ResponseMsgPageDataMerchantBalanceLogRespVo` OK
1401
- */
1402
- balanceLogGetGet: (query: {
1403
- param: MerchantBalanceLogReqVo;
1404
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgPageDataMerchantBalanceLogRespVo, any, {}>>;
1405
- /**
1406
- * No description
1407
- *
1408
- * @tags 商户管理员模块
1409
- * @name AdminListGet
1410
- * @summary 获取商户管理员列表
1411
- * @request GET:/merchant/admin/list
1412
- * @response `200` `ResponseMsgPageDataMerchantAdminVo` OK
1413
- */
1414
- adminListGet: (query: {
1415
- /** 商户管理员列表 */
1416
- param: MerchantAdminListReqVo;
1417
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgPageDataMerchantAdminVo, any, {}>>;
1418
- /**
1419
- * No description
1420
- *
1421
- * @tags 商户管理员模块
1422
- * @name AdminGetGet
1423
- * @summary 获取商户管理员信息
1424
- * @request GET:/merchant/admin/get
1425
- * @response `200` `ResponseMsgMerchantAdminVo` OK
1426
- */
1427
- adminGetGet: (query?: {
1428
- /**
1429
- * @format int64
1430
- * @default -1
1431
- */
1432
- id?: number;
1433
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgMerchantAdminVo, any, {}>>;
1434
- };
1435
- joinpay: {
1436
- /**
1437
- * @description 平台与分账方之间转账
1438
- *
1439
- * @tags 汇聚支付-交易模块
1440
- * @name TransactionTransferLaunchPost
1441
- * @summary 发起转账
1442
- * @request POST:/joinpay/transaction/transfer/launch
1443
- * @response `200` `ResponseMsgJpTransferRespVo` OK
1444
- */
1445
- transactionTransferLaunchPost: (data: JpTransferLaunchReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgJpTransferRespVo, any, {}>>;
1446
- /**
1447
- * @description 平台转账至银行卡
1448
- *
1449
- * @tags 汇聚支付-交易模块
1450
- * @name TransactionBatchPayLaunchPost
1451
- * @summary 发起批量代付
1452
- * @request POST:/joinpay/transaction/batch-pay/launch
1453
- * @response `200` `ResponseMsgJpBatchPayRespVo` OK
1454
- */
1455
- transactionBatchPayLaunchPost: (data: JpBatchPayLaunchRequest, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgJpBatchPayRespVo, any, {}>>;
1456
- /**
1457
- * No description
1458
- *
1459
- * @tags 汇聚支付-交易模块
1460
- * @name TransactionTransferListGet
1461
- * @summary 获取交易明细列表
1462
- * @request GET:/joinpay/transaction/transfer/list
1463
- * @response `200` `ResponseMsgPageDataJpTransferRespVo` OK
1464
- */
1465
- transactionTransferListGet: (query: {
1466
- /** 汇聚支付- 转账列表响应 */
1467
- param: JpTransferListReqVo;
1468
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgPageDataJpTransferRespVo, any, {}>>;
1469
- /**
1470
- * No description
1471
- *
1472
- * @tags 汇聚支付-交易模块
1473
- * @name TransactionTransferGetGet
1474
- * @summary 通过交易明细Id,获取交易明细详情
1475
- * @request GET:/joinpay/transaction/transfer/get
1476
- * @response `200` `ResponseMsgJpTransferRespVo` OK
1477
- */
1478
- transactionTransferGetGet: (query: {
1479
- /** @format int64 */
1480
- id: number;
1481
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgJpTransferRespVo, any, {}>>;
1482
- /**
1483
- * No description
1484
- *
1485
- * @tags 汇聚支付-交易模块
1486
- * @name TransactionBatchPayListGet
1487
- * @summary 获取批量代付列表
1488
- * @request GET:/joinpay/transaction/batch-pay/list
1489
- * @response `200` `ResponseMsgPageDataJpBatchPayRespVo` OK
1490
- */
1491
- transactionBatchPayListGet: (query: {
1492
- /** 汇聚支付- 批量代付列表查询 */
1493
- param: JpBatchPayListReqVo;
1494
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgPageDataJpBatchPayRespVo, any, {}>>;
1495
- /**
1496
- * No description
1497
- *
1498
- * @tags 汇聚支付-交易模块
1499
- * @name TransactionBatchPayGetGet
1500
- * @summary 获取批量代付详情
1501
- * @request GET:/joinpay/transaction/batch-pay/get
1502
- * @response `200` `ResponseMsgJpBatchPayRespVo` OK
1503
- */
1504
- transactionBatchPayGetGet: (query: {
1505
- /** @format int64 */
1506
- batchPayId: number;
1507
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgJpBatchPayRespVo, any, {}>>;
1508
- /**
1509
- * No description
1510
- *
1511
- * @tags 汇聚支付-商户模块
1512
- * @name MerchantListGet
1513
- * @summary 获取商户分页
1514
- * @request GET:/joinpay/merchant/list
1515
- * @response `200` `ResponseMsgPageDataJpMerchantRespVo` OK
1516
- */
1517
- merchantListGet: (query: {
1518
- /** 商户分页 参数 */
1519
- param: JpMerchantPageQuery;
1520
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgPageDataJpMerchantRespVo, any, {}>>;
1521
- };
1522
- external: {
1523
- /**
1524
- * No description
1525
- *
1526
- * @tags 凯聚通API模块
1527
- * @name V1SignPost
1528
- * @request POST:/external/v1/sign
1529
- * @response `200` `ResponseMsgExternalReqVo` OK
1530
- */
1531
- v1SignPost: (params?: RequestParams) => Promise<AxiosResponse<ResponseMsgExternalReqVo, any, {}>>;
1532
- /**
1533
- * No description
1534
- *
1535
- * @tags 凯聚通API模块
1536
- * @name V1InvokePost
1537
- * @summary 统一入口
1538
- * @request POST:/external/v1/invoke
1539
- * @response `200` `ResponseMsgObject` OK
1540
- */
1541
- v1InvokePost: (data: ExternalReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgObject, any, {}>>;
1542
- };
1543
- captcha: {
1544
- /**
1545
- * @description 5分钟内有效
1546
- *
1547
- * @tags 验证码模块
1548
- * @name SmsPost
1549
- * @summary 发送短信验证码
1550
- * @request POST:/captcha/sms
1551
- * @response `200` `ResponseMsgCaptchaSmsSendRespVo` OK
1552
- */
1553
- smsPost: (data: CaptchaSmsSendReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgCaptchaSmsSendRespVo, any, {}>>;
1554
- /**
1555
- * @description 5分钟内有效
1556
- *
1557
- * @tags 验证码模块
1558
- * @name ImageGenerateGet
1559
- * @summary 生成图像验证码
1560
- * @request GET:/captcha/image/generate
1561
- * @response `200` `ResponseMsgCaptchaImageVo` OK
1562
- */
1563
- imageGenerateGet: (params?: RequestParams) => Promise<AxiosResponse<ResponseMsgCaptchaImageVo, any, {}>>;
1564
- };
1565
- admin: {
1566
- /**
1567
- * No description
1568
- *
1569
- * @tags 管理员模块
1570
- * @name UpdatePost
1571
- * @summary 更新管理员信息
1572
- * @request POST:/admin/update
1573
- * @response `200` `ResponseMsgObject` OK
1574
- */
1575
- updatePost: (data: AdminUpdateReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgObject, any, {}>>;
1576
- /**
1577
- * No description
1578
- *
1579
- * @tags 管理员模块
1580
- * @name UpdatePhonePost
1581
- * @summary 修改手机号码
1582
- * @request POST:/admin/update/phone
1583
- * @response `200` `ResponseMsgString` OK
1584
- */
1585
- updatePhonePost: (data: AdminUpdatePhoneReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgString, any, {}>>;
1586
- /**
1587
- * @description 登出当前登录的管理员
1588
- *
1589
- * @tags 管理员模块
1590
- * @name LogoutPost
1591
- * @summary 登出
1592
- * @request POST:/admin/logout
1593
- * @response `200` `ResponseMsgString` OK
1594
- */
1595
- logoutPost: (params?: RequestParams) => Promise<AxiosResponse<ResponseMsgString, any, {}>>;
1596
- /**
1597
- * No description
1598
- *
1599
- * @tags 管理员模块
1600
- * @name LoginPhonePost
1601
- * @summary 通过手机验证登录
1602
- * @request POST:/admin/login/phone
1603
- * @response `200` `ResponseMsgAdminLoginRespVo` OK
1604
- */
1605
- loginPhonePost: (data: AdminLoginReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgAdminLoginRespVo, any, {}>>;
1606
- /**
1607
- * No description
1608
- *
1609
- * @tags 管理员模块
1610
- * @name DeletePost
1611
- * @summary 删除管理员(软删除)
1612
- * @request POST:/admin/delete
1613
- * @response `200` `ResponseMsgObject` OK
1614
- */
1615
- deletePost: (query: {
1616
- /** 管理员id,多个请用,隔开 */
1617
- adminIds: string;
1618
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgObject, any, {}>>;
1619
- /**
1620
- * No description
1621
- *
1622
- * @tags 管理员模块
1623
- * @name CreatePost
1624
- * @summary 创建管理员
1625
- * @request POST:/admin/create
1626
- * @response `200` `ResponseMsgAdminVo` OK
1627
- */
1628
- createPost: (data: AdminCreateReqVo, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgAdminVo, any, {}>>;
1629
- /**
1630
- * No description
1631
- *
1632
- * @tags 管理员模块
1633
- * @name ListGet
1634
- * @summary 获取管理员列表
1635
- * @request GET:/admin/list
1636
- * @response `200` `ResponseMsgPageDataAdminVo` OK
1637
- */
1638
- listGet: (query: {
1639
- param: AdminListReqVo;
1640
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgPageDataAdminVo, any, {}>>;
1641
- /**
1642
- * No description
1643
- *
1644
- * @tags 管理员模块
1645
- * @name GetGet
1646
- * @summary 获取指定管理员信息
1647
- * @request GET:/admin/get
1648
- * @response `200` `ResponseMsgAdminVo` OK
1649
- */
1650
- getGet: (query?: {
1651
- /**
1652
- * 为空时,表示自己
1653
- * @format int64
1654
- */
1655
- id?: number;
1656
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgAdminVo, any, {}>>;
1657
- };
1658
- common: {
1659
- /**
1660
- * No description
1661
- *
1662
- * @tags 通用模块
1663
- * @name EnumListGet
1664
- * @summary 获取枚举列表,多个请用,隔开
1665
- * @request GET:/common/enum/list
1666
- * @response `200` `ResponseMsgListEnumVo` OK
1667
- */
1668
- enumListGet: (query: {
1669
- /** 枚举列表请求参数 */
1670
- param: EnumListReqVo;
1671
- }, params?: RequestParams) => Promise<AxiosResponse<ResponseMsgListEnumVo, any, {}>>;
1672
- };
1673
- }