@wilix/billbill-client-js 0.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.
Files changed (46) hide show
  1. package/README.md +31 -0
  2. package/dist/apiClient.d.ts +19 -0
  3. package/dist/apiClient.d.ts.map +1 -0
  4. package/dist/apiClient.js +46 -0
  5. package/dist/apiClient.js.map +1 -0
  6. package/dist/index.d.ts +7 -0
  7. package/dist/index.d.ts.map +1 -0
  8. package/dist/index.js +15 -0
  9. package/dist/index.js.map +1 -0
  10. package/dist/merchant.d.ts +2144 -0
  11. package/dist/merchant.d.ts.map +1 -0
  12. package/dist/merchant.js +1819 -0
  13. package/dist/merchant.js.map +1 -0
  14. package/dist/system.d.ts +94 -0
  15. package/dist/system.d.ts.map +1 -0
  16. package/dist/system.js +100 -0
  17. package/dist/system.js.map +1 -0
  18. package/dist/types/edm.d.ts +26 -0
  19. package/dist/types/edm.d.ts.map +1 -0
  20. package/dist/types/edm.js +3 -0
  21. package/dist/types/edm.js.map +1 -0
  22. package/dist/types/interface.d.ts +8 -0
  23. package/dist/types/interface.d.ts.map +1 -0
  24. package/dist/types/interface.js +3 -0
  25. package/dist/types/interface.js.map +1 -0
  26. package/dist/types/merchant.d.ts +1916 -0
  27. package/dist/types/merchant.d.ts.map +1 -0
  28. package/dist/types/merchant.js +3 -0
  29. package/dist/types/merchant.js.map +1 -0
  30. package/dist/types/shared.d.ts +1211 -0
  31. package/dist/types/shared.d.ts.map +1 -0
  32. package/dist/types/shared.js +3 -0
  33. package/dist/types/shared.js.map +1 -0
  34. package/dist/types/system.d.ts +78 -0
  35. package/dist/types/system.d.ts.map +1 -0
  36. package/dist/types/system.js +3 -0
  37. package/dist/types/system.js.map +1 -0
  38. package/dist/types/user.d.ts +491 -0
  39. package/dist/types/user.d.ts.map +1 -0
  40. package/dist/types/user.js +3 -0
  41. package/dist/types/user.js.map +1 -0
  42. package/dist/user.d.ts +589 -0
  43. package/dist/user.d.ts.map +1 -0
  44. package/dist/user.js +466 -0
  45. package/dist/user.js.map +1 -0
  46. package/package.json +76 -0
@@ -0,0 +1,1916 @@
1
+ import { SbisOrgData } from './edm';
2
+ import { DetailMerchantMemberDetail, CreditConfig, DetailCreditAccountDetail, UserAccount, CreditAccount, CreditConfigStatistics, Merchant, DetailGateway, DetailGatewayBank, CreditRecharge, Invoice, Plan, MerchantDiscountCode, Payment, DetailMerchantDiscountCodeDetail, Sender, DetailInvoiceDetail, Subscription, Refund, MerchantMetric, MerchantMetricEvent, DetailMerchantMetricPlanLimitDetail, DetailUserMetric, Product, DetailPaymentDetail, PaymentMethod, DetailRefundDetail, DetailPlanDetail, DetailUserAccountDetail, SubscriptionConfig, NewUser, ValidResult, DetailSubscriptionDetail, DetailSubscriptionPendingUpdateDetail, ExternalDiscountParam, PlanProductParam, SubscriptionOnetimeAddon, MerchantBatchExportTemplate, UserWallet } from "./shared";
3
+ export type AuthLoginReq = {
4
+ email: string;
5
+ password: string;
6
+ };
7
+ export type AuthLoginRes = {
8
+ merchantMember?: DetailMerchantMemberDetail;
9
+ token?: string;
10
+ };
11
+ export type AuthLoginOtpReq = {
12
+ email: string;
13
+ };
14
+ export type AuthLoginOtpRes = {};
15
+ export type AuthLoginOtpVerifyReq = {
16
+ email: string;
17
+ verificationCode: string;
18
+ };
19
+ export type AuthLoginOtpVerifyRes = {
20
+ merchantMember?: DetailMerchantMemberDetail;
21
+ token?: string;
22
+ };
23
+ export type AuthPasswordForgetOtpReq = {
24
+ email: string;
25
+ };
26
+ export type AuthPasswordForgetOtpRes = {};
27
+ export type AuthPasswordForgetOtpVerifyReq = {
28
+ email: string;
29
+ verificationCode: string;
30
+ newPassword: string;
31
+ };
32
+ export type AuthPasswordForgetOtpVerifyRes = {};
33
+ export type AuthPasswordSetupOtpReq = {
34
+ email: string;
35
+ setupToken: string;
36
+ newPassword: string;
37
+ };
38
+ export type AuthPasswordSetupOtpRes = {};
39
+ export type AuthRegisterReq = {
40
+ firstName: string;
41
+ lastName: string;
42
+ email: string;
43
+ password: string;
44
+ phone?: string;
45
+ userName?: string;
46
+ };
47
+ export type AuthRegisterRes = {};
48
+ export type AuthRegisterVerifyReq = {
49
+ email: string;
50
+ verificationCode: string;
51
+ };
52
+ export type AuthRegisterVerifyRes = {
53
+ merchantMember?: DetailMerchantMemberDetail;
54
+ };
55
+ export type ProfileCountryConfigListReq = {};
56
+ export type ProfileCountryConfigListRes = {
57
+ configs?: string[];
58
+ };
59
+ export type ProfileEditCountryConfigReq = {
60
+ countryCode: string;
61
+ name?: string;
62
+ vatEnable?: boolean;
63
+ };
64
+ export type ProfileEditCountryConfigRes = {};
65
+ export type ProfileGetReq = {};
66
+ export type ProfileGetRes = {
67
+ merchant?: Merchant;
68
+ merchantMember?: DetailMerchantMemberDetail;
69
+ env?: string;
70
+ isProd?: boolean;
71
+ TimeZone?: string[];
72
+ Currency?: string[];
73
+ gateways?: string[];
74
+ exchangeRateApiKey?: string;
75
+ openApiKey?: string;
76
+ sendGridKey?: string;
77
+ vatSenseKey?: string;
78
+ emailSender?: Sender;
79
+ segmentServerSideKey?: string;
80
+ segmentUserPortalKey?: string;
81
+ isOwner?: boolean;
82
+ MemberRoles?: string[];
83
+ };
84
+ export type ProfileNewApiKeyReq = {};
85
+ export type ProfileNewApiKeyRes = {
86
+ apiKey?: string;
87
+ };
88
+ export type ProfileUpdateReq = {
89
+ companyName?: string;
90
+ email?: string;
91
+ address?: string;
92
+ companyLogo?: string;
93
+ phone?: string;
94
+ timeZone?: string;
95
+ host?: string;
96
+ };
97
+ export type ProfileUpdateRes = {
98
+ merchant?: Merchant;
99
+ };
100
+ export type CreditConfigListReq = {
101
+ types?: string[];
102
+ currency?: string;
103
+ };
104
+ export type CreditConfigListRes = {
105
+ creditConfigs?: string[];
106
+ };
107
+ export type CreditCreditAccountListReq = {
108
+ userId?: number;
109
+ email?: string;
110
+ sortField?: string;
111
+ sortType?: string;
112
+ page?: number;
113
+ count?: number;
114
+ createTimeStart?: number;
115
+ createTimeEnd?: number;
116
+ };
117
+ export type CreditCreditAccountListRes = {
118
+ creditAccounts?: string[];
119
+ total?: number;
120
+ };
121
+ export type CreditCreditTransactionListReq = {
122
+ accountType: number;
123
+ userId?: number;
124
+ email?: string;
125
+ currency?: string;
126
+ sortField?: string;
127
+ sortType?: string;
128
+ transactionTypes?: string[];
129
+ page?: number;
130
+ count?: number;
131
+ createTimeStart?: number;
132
+ createTimeEnd?: number;
133
+ };
134
+ export type CreditCreditTransactionListRes = {
135
+ creditTransactions?: string[];
136
+ total?: number;
137
+ };
138
+ export type CreditDetailReq = {
139
+ id: number;
140
+ };
141
+ export type CreditDetailRes = {
142
+ creditAccount?: DetailCreditAccountDetail;
143
+ creditTransactions?: string[];
144
+ };
145
+ export type CreditEditConfigReq = {
146
+ type: number;
147
+ currency: string;
148
+ exchangeRate?: number;
149
+ name?: string;
150
+ description?: string;
151
+ recurring?: number;
152
+ discountCodeExclusive?: number;
153
+ logo?: string;
154
+ logoUrl?: string;
155
+ rechargeEnable?: number;
156
+ payoutEnable?: number;
157
+ previewDefaultUsed?: number;
158
+ metaData?: object;
159
+ };
160
+ export type CreditEditConfigRes = {
161
+ creditConfig?: CreditConfig;
162
+ };
163
+ export type CreditEditCreditAccountReq = {
164
+ id: number;
165
+ rechargeEnable?: number;
166
+ payoutEnable?: number;
167
+ };
168
+ export type CreditEditCreditAccountRes = {
169
+ UserCreditAccount?: CreditAccount;
170
+ };
171
+ export type CreditEditPromoConfigReq = {
172
+ currency: string;
173
+ exchangeRate?: number;
174
+ name?: string;
175
+ description?: string;
176
+ recurring?: number;
177
+ discountCodeExclusive?: number;
178
+ logo?: string;
179
+ logoUrl?: string;
180
+ rechargeEnable?: number;
181
+ payoutEnable?: number;
182
+ previewDefaultUsed?: number;
183
+ metaData?: object;
184
+ };
185
+ export type CreditEditPromoConfigRes = {
186
+ creditConfig?: CreditConfig;
187
+ };
188
+ export type CreditPromoConfigReq = {
189
+ currency?: string;
190
+ };
191
+ export type CreditPromoConfigRes = {
192
+ creditConfig?: CreditConfig;
193
+ };
194
+ export type CreditPromoConfigStatisticsReq = {
195
+ currency?: string;
196
+ };
197
+ export type CreditPromoConfigStatisticsRes = {
198
+ creditConfigStatistics?: CreditConfigStatistics;
199
+ };
200
+ export type CreditNewConfigReq = {
201
+ name?: string;
202
+ description?: string;
203
+ type: number;
204
+ currency: string;
205
+ exchangeRate?: number;
206
+ recurring?: number;
207
+ discountCodeExclusive?: number;
208
+ logo?: string;
209
+ logoUrl?: string;
210
+ rechargeEnable?: number;
211
+ payoutEnable?: number;
212
+ previewDefaultUsed?: number;
213
+ metaData?: object;
214
+ };
215
+ export type CreditNewConfigRes = {
216
+ creditConfig?: CreditConfig;
217
+ };
218
+ export type CreditNewCreditRechargeReq = {
219
+ userId?: number;
220
+ currency?: string;
221
+ creditAccountId?: number;
222
+ gatewayId: number;
223
+ rechargeAmount: number;
224
+ name?: string;
225
+ description?: string;
226
+ returnUrl?: string;
227
+ cancelUrl?: string;
228
+ };
229
+ export type CreditNewCreditRechargeRes = {
230
+ user?: UserAccount;
231
+ merchant?: Merchant;
232
+ gateway?: DetailGateway;
233
+ creditAccount?: CreditAccount;
234
+ creditRecharge?: CreditRecharge;
235
+ invoice?: Invoice;
236
+ payment?: Payment;
237
+ link?: string;
238
+ paid?: boolean;
239
+ };
240
+ export type CreditPromoCreditDecrementReq = {
241
+ userId: number;
242
+ currency: string;
243
+ amount: number;
244
+ name?: string;
245
+ description?: string;
246
+ };
247
+ export type CreditPromoCreditDecrementRes = {
248
+ UserPromoCreditAccount?: CreditAccount;
249
+ };
250
+ export type CreditPromoCreditIncrementReq = {
251
+ userId: number;
252
+ currency: string;
253
+ amount: number;
254
+ name?: string;
255
+ description?: string;
256
+ };
257
+ export type CreditPromoCreditIncrementRes = {
258
+ UserPromoCreditAccount?: CreditAccount;
259
+ };
260
+ export type DiscountActivateReq = {
261
+ id: number;
262
+ };
263
+ export type DiscountActivateRes = {};
264
+ export type DiscountDeactivateReq = {
265
+ id: number;
266
+ };
267
+ export type DiscountDeactivateRes = {};
268
+ export type DiscountQuantityDecrementReq = {
269
+ id: number;
270
+ amount?: number;
271
+ };
272
+ export type DiscountQuantityDecrementRes = {
273
+ discountCode?: MerchantDiscountCode;
274
+ };
275
+ export type DiscountDeleteReq = {
276
+ id: number;
277
+ };
278
+ export type DiscountDeleteRes = {};
279
+ export type DiscountDetailReq = {
280
+ id: number;
281
+ };
282
+ export type DiscountDetailRes = {
283
+ discount?: DetailMerchantDiscountCodeDetail;
284
+ };
285
+ export type DiscountEditReq = {
286
+ id: number;
287
+ name?: string;
288
+ billingType?: number;
289
+ discountType?: number;
290
+ discountAmount?: number;
291
+ discountPercentage?: number;
292
+ currency?: string;
293
+ cycleLimit?: number;
294
+ startTime?: number;
295
+ endTime?: number;
296
+ planApplyType?: number;
297
+ planIds?: string[];
298
+ quantity?: number;
299
+ advance?: boolean;
300
+ userScope?: number;
301
+ upgradeOnly?: boolean;
302
+ upgradeLongPlanOnly?: boolean;
303
+ userLimit?: number;
304
+ metadata?: object;
305
+ };
306
+ export type DiscountEditRes = {
307
+ discount?: MerchantDiscountCode;
308
+ };
309
+ export type DiscountListReq = {
310
+ discountType?: string[];
311
+ billingType?: string[];
312
+ status?: string[];
313
+ code?: string;
314
+ searchKey?: string;
315
+ currency?: string;
316
+ sortField?: string;
317
+ sortType?: string;
318
+ page?: number;
319
+ count?: number;
320
+ createTimeStart?: number;
321
+ createTimeEnd?: number;
322
+ };
323
+ export type DiscountListRes = {
324
+ discounts?: string[];
325
+ total?: number;
326
+ };
327
+ export type DiscountNewReq = {
328
+ code: string;
329
+ name?: string;
330
+ billingType: number;
331
+ discountType: number;
332
+ discountAmount?: number;
333
+ discountPercentage?: number;
334
+ currency?: string;
335
+ cycleLimit?: number;
336
+ startTime: number;
337
+ endTime: number;
338
+ planApplyType?: number;
339
+ planIds?: string[];
340
+ quantity?: number;
341
+ advance?: boolean;
342
+ userScope?: number;
343
+ upgradeOnly?: boolean;
344
+ upgradeLongPlanOnly?: boolean;
345
+ userLimit?: number;
346
+ metadata?: object;
347
+ };
348
+ export type DiscountNewRes = {
349
+ discount?: MerchantDiscountCode;
350
+ };
351
+ export type DiscountPlanApplyPreviewReq = {
352
+ code: string;
353
+ planId?: number;
354
+ externalPlanId?: string;
355
+ isUpgrade?: boolean;
356
+ isChangeToSameIntervalPlan?: boolean;
357
+ isChangeToLongPlan?: boolean;
358
+ email?: string;
359
+ };
360
+ export type DiscountPlanApplyPreviewRes = {
361
+ valid?: boolean;
362
+ discountAmount?: number;
363
+ discountCode?: MerchantDiscountCode;
364
+ failureReason?: string;
365
+ };
366
+ export type DiscountQuantityIncrementReq = {
367
+ id: number;
368
+ amount?: number;
369
+ };
370
+ export type DiscountQuantityIncrementRes = {
371
+ discountCode?: MerchantDiscountCode;
372
+ };
373
+ export type DiscountUserDiscountListReq = {
374
+ id: number;
375
+ userIds?: string[];
376
+ email?: string;
377
+ planIds?: string[];
378
+ sortField?: string;
379
+ sortType?: string;
380
+ page?: number;
381
+ count?: number;
382
+ createTimeStart?: number;
383
+ createTimeEnd?: number;
384
+ };
385
+ export type DiscountUserDiscountListRes = {
386
+ userDiscounts?: string[];
387
+ total?: number;
388
+ };
389
+ export type EdmGetIdentityReq = {
390
+ mode: string;
391
+ inn: string;
392
+ kpp?: string;
393
+ };
394
+ export type EdmGetIdentityRes = {
395
+ data?: SbisOrgData;
396
+ };
397
+ export type EdmSetupGatewayReq = {
398
+ gatewayName: string;
399
+ appClientId: string;
400
+ appSecret: string;
401
+ secretKey: string;
402
+ isDefault?: boolean;
403
+ };
404
+ export type EdmSetupGatewayRes = {
405
+ result?: boolean;
406
+ };
407
+ export type EmailCustomizeLocalizationTemplateSyncReq = {
408
+ templateData: string[];
409
+ versionEnable?: boolean;
410
+ };
411
+ export type EmailCustomizeLocalizationTemplateSyncRes = {};
412
+ export type EmailSenderSetupReq = {
413
+ name: string;
414
+ address: string;
415
+ };
416
+ export type EmailSenderSetupRes = {};
417
+ export type EmailGatewaySetupReq = {
418
+ gatewayName: string;
419
+ data: string;
420
+ IsDefault?: boolean;
421
+ };
422
+ export type EmailGatewaySetupRes = {
423
+ data?: string;
424
+ };
425
+ export type EmailSendTemplateEmailToUserReq = {
426
+ templateName: string;
427
+ userId: number;
428
+ variables?: object;
429
+ };
430
+ export type EmailSendTemplateEmailToUserRes = {};
431
+ export type EmailTemplateActivateReq = {
432
+ templateName: string;
433
+ };
434
+ export type EmailTemplateActivateRes = {};
435
+ export type EmailTemplateDeactivateReq = {
436
+ templateName: string;
437
+ };
438
+ export type EmailTemplateDeactivateRes = {};
439
+ export type EmailTemplateListReq = {};
440
+ export type EmailTemplateListRes = {
441
+ emailTemplateList?: string[];
442
+ total?: number;
443
+ };
444
+ export type EmailTemplateSetDefaultReq = {
445
+ templateName: string;
446
+ };
447
+ export type EmailTemplateSetDefaultRes = {};
448
+ export type EmailTemplateUpdateReq = {
449
+ templateName: string;
450
+ templateTitle: string;
451
+ templateContent: string;
452
+ };
453
+ export type EmailTemplateUpdateRes = {};
454
+ export type GatewayArchiveReq = {
455
+ gatewayId: number;
456
+ };
457
+ export type GatewayArchiveRes = {
458
+ gateway?: DetailGateway;
459
+ };
460
+ export type GatewayDetailReq = {
461
+ gatewayId?: number;
462
+ gatewayName?: string;
463
+ };
464
+ export type GatewayDetailRes = {
465
+ gateway?: DetailGateway;
466
+ };
467
+ export type GatewayEditReq = {
468
+ gatewayId: number;
469
+ displayName?: string;
470
+ gatewayLogo?: string[];
471
+ sort?: number;
472
+ gatewayKey?: string;
473
+ gatewaySecret?: string;
474
+ subGateway?: string;
475
+ currencyExchange?: string[];
476
+ gatewayPaymentTypes?: string[];
477
+ };
478
+ export type GatewayEditRes = {
479
+ gateway?: DetailGateway;
480
+ };
481
+ export type GatewayEditCountryConfigReq = {
482
+ gatewayId: number;
483
+ countryConfig?: object;
484
+ };
485
+ export type GatewayEditCountryConfigRes = {};
486
+ export type GatewayEditSortReq = {
487
+ gatewaySorts?: string[];
488
+ };
489
+ export type GatewayEditSortRes = {
490
+ gateways?: string[];
491
+ };
492
+ export type GatewayListReq = {
493
+ archive?: boolean;
494
+ };
495
+ export type GatewayListRes = {
496
+ gateways?: string[];
497
+ };
498
+ export type GatewaySetupReq = {
499
+ gatewayName: string;
500
+ displayName?: string;
501
+ gatewayIcons?: string[];
502
+ sort?: number;
503
+ gatewayKey?: string;
504
+ gatewaySecret?: string;
505
+ subGateway?: string;
506
+ currencyExchange?: string[];
507
+ gatewayPaymentTypes?: string[];
508
+ };
509
+ export type GatewaySetupRes = {
510
+ gateway?: DetailGateway;
511
+ };
512
+ export type GatewaySetupExchangeApiReq = {
513
+ exchangeRateApiKey?: string;
514
+ };
515
+ export type GatewaySetupExchangeApiRes = {
516
+ data?: string;
517
+ };
518
+ export type GatewaySetupListReq = {};
519
+ export type GatewaySetupListRes = {
520
+ gateways?: string[];
521
+ };
522
+ export type GatewaySetupWebhookReq = {
523
+ gatewayId: number;
524
+ webhookSecret?: string;
525
+ };
526
+ export type GatewaySetupWebhookRes = {
527
+ gatewayWebhookUrl?: string;
528
+ };
529
+ export type GatewayWireTransferEditReq = {
530
+ gatewayId: number;
531
+ displayName?: string;
532
+ gatewayIcons?: string[];
533
+ sort?: number;
534
+ currency: string;
535
+ minimumAmount: number;
536
+ bank?: DetailGatewayBank;
537
+ };
538
+ export type GatewayWireTransferEditRes = {
539
+ gateway?: DetailGateway;
540
+ };
541
+ export type GatewayWireTransferSetupReq = {
542
+ displayName?: string;
543
+ gatewayIcons?: string[];
544
+ sort?: number;
545
+ currency: string;
546
+ minimumAmount: number;
547
+ bank?: DetailGatewayBank;
548
+ };
549
+ export type GatewayWireTransferSetupRes = {
550
+ gateway?: DetailGateway;
551
+ };
552
+ export type InvoiceCancelReq = {
553
+ invoiceId: string;
554
+ };
555
+ export type InvoiceCancelRes = {};
556
+ export type InvoiceDeleteReq = {
557
+ invoiceId: string;
558
+ };
559
+ export type InvoiceDeleteRes = {};
560
+ export type InvoiceDetailReq = {
561
+ invoiceId: string;
562
+ };
563
+ export type InvoiceDetailRes = {
564
+ invoice?: DetailInvoiceDetail;
565
+ creditNotes?: string[];
566
+ };
567
+ export type InvoiceEditReq = {
568
+ invoiceId: string;
569
+ taxPercentage?: number;
570
+ gatewayId?: number;
571
+ currency?: string;
572
+ name?: string;
573
+ lines?: string[];
574
+ finish?: boolean;
575
+ };
576
+ export type InvoiceNewInvoiceItemParam = {
577
+ unitAmountExcludingTax?: number;
578
+ name?: string;
579
+ description?: string;
580
+ quantity?: number;
581
+ };
582
+ export type InvoiceEditRes = {
583
+ invoice?: DetailInvoiceDetail;
584
+ };
585
+ export type InvoiceFinishReq = {
586
+ invoiceId: string;
587
+ daysUtilDue: number;
588
+ };
589
+ export type InvoiceFinishRes = {
590
+ invoice?: Invoice;
591
+ };
592
+ export type InvoiceListReq = {
593
+ firstName?: string;
594
+ lastName?: string;
595
+ currency?: string;
596
+ status?: string[];
597
+ amountStart?: number;
598
+ amountEnd?: number;
599
+ userId?: number;
600
+ sendEmail?: string;
601
+ sortField?: string;
602
+ sortType?: string;
603
+ deleteInclude?: boolean;
604
+ type?: number;
605
+ page?: number;
606
+ count?: number;
607
+ createTimeStart?: number;
608
+ createTimeEnd?: number;
609
+ reportTimeStart?: number;
610
+ reportTimeEnd?: number;
611
+ };
612
+ export type InvoiceListRes = {
613
+ invoices?: string[];
614
+ total?: number;
615
+ };
616
+ export type InvoiceMarkRefundReq = {
617
+ invoiceId: string;
618
+ refundNo?: string;
619
+ refundAmount: number;
620
+ reason: string;
621
+ };
622
+ export type InvoiceMarkRefundRes = {
623
+ refund?: Refund;
624
+ };
625
+ export type InvoiceMarkRefundInvoiceSuccessReq = {
626
+ invoiceId: string;
627
+ reason?: string;
628
+ };
629
+ export type InvoiceMarkRefundInvoiceSuccessRes = {};
630
+ export type InvoiceMarkWireTransferSuccessReq = {
631
+ invoiceId: string;
632
+ transferNumber: string;
633
+ reason?: string;
634
+ };
635
+ export type InvoiceMarkWireTransferSuccessRes = {};
636
+ export type InvoiceNewReq = {
637
+ userId: number;
638
+ taxPercentage: number;
639
+ gatewayId?: number;
640
+ currency: string;
641
+ name?: string;
642
+ lines?: string[];
643
+ finish?: boolean;
644
+ };
645
+ export type InvoiceNewRes = {
646
+ invoice?: DetailInvoiceDetail;
647
+ };
648
+ export type InvoicePdfGenerateReq = {
649
+ invoiceId: string;
650
+ sendUserEmail?: boolean;
651
+ };
652
+ export type InvoicePdfGenerateRes = {};
653
+ export type InvoicePdfUpdateReq = {
654
+ invoiceId: string;
655
+ issueCompanyName?: string;
656
+ issueAddress?: string;
657
+ issueVatNumber?: string;
658
+ issueRegNumber?: string;
659
+ localizedCurrency?: string;
660
+ localizedExchangeRate?: number;
661
+ localizedExchangeRateDescription?: number;
662
+ showDetailItem?: boolean;
663
+ sendUserEmail?: boolean;
664
+ template?: string;
665
+ metadata?: object;
666
+ };
667
+ export type InvoicePdfUpdateRes = {};
668
+ export type InvoiceReconvertCryptoAndSendReq = {
669
+ invoiceId: string;
670
+ };
671
+ export type InvoiceReconvertCryptoAndSendRes = {};
672
+ export type InvoiceRefundReq = {
673
+ invoiceId: string;
674
+ refundNo?: string;
675
+ refundAmount: number;
676
+ reason: string;
677
+ };
678
+ export type InvoiceRefundRes = {
679
+ refund?: Refund;
680
+ };
681
+ export type InvoiceSendEmailReq = {
682
+ invoiceId: string;
683
+ };
684
+ export type InvoiceSendEmailRes = {};
685
+ export type MemberListReq = {
686
+ roleIds?: string[];
687
+ page?: number;
688
+ count?: number;
689
+ };
690
+ export type MemberListRes = {
691
+ merchantMembers?: string[];
692
+ total?: number;
693
+ };
694
+ export type MemberLogoutReq = {};
695
+ export type MemberLogoutRes = {};
696
+ export type MemberNewMemberReq = {
697
+ email: string;
698
+ roleIds: string[];
699
+ firstName?: string;
700
+ lastName?: string;
701
+ };
702
+ export type MemberNewMemberRes = {};
703
+ export type MemberOperationLogListReq = {
704
+ memberFirstName?: string;
705
+ memberLastName?: string;
706
+ memberEmail?: string;
707
+ firstName?: string;
708
+ lastName?: string;
709
+ email?: string;
710
+ subscriptionId?: string;
711
+ invoiceId?: string;
712
+ planId?: number;
713
+ discountCode?: string;
714
+ page?: number;
715
+ count?: number;
716
+ };
717
+ export type MemberOperationLogListRes = {
718
+ merchantOperationLogs?: string[];
719
+ total?: number;
720
+ };
721
+ export type MemberPasswordResetReq = {
722
+ oldPassword: string;
723
+ newPassword: string;
724
+ };
725
+ export type MemberPasswordResetRes = {};
726
+ export type MemberProfileReq = {};
727
+ export type MemberProfileRes = {
728
+ merchantMember?: DetailMerchantMemberDetail;
729
+ };
730
+ export type MemberReleaseReq = {
731
+ memberId?: number;
732
+ };
733
+ export type MemberReleaseRes = {};
734
+ export type MemberFrozenReq = {
735
+ memberId?: number;
736
+ };
737
+ export type MemberFrozenRes = {};
738
+ export type MemberUpdateReq = {
739
+ firstName?: string;
740
+ lastName?: string;
741
+ mobile?: string;
742
+ };
743
+ export type MemberUpdateRes = {
744
+ merchantMember?: DetailMerchantMemberDetail;
745
+ };
746
+ export type MemberUpdateMemberRoleReq = {
747
+ memberId?: number;
748
+ roleIds?: string[];
749
+ };
750
+ export type MemberUpdateMemberRoleRes = {};
751
+ export type MetricDeleteReq = {
752
+ metricId: number;
753
+ };
754
+ export type MetricDeleteRes = {
755
+ merchantMetric?: MerchantMetric;
756
+ };
757
+ export type MetricDetailReq = {
758
+ metricId: number;
759
+ };
760
+ export type MetricDetailRes = {
761
+ merchantMetric?: MerchantMetric;
762
+ };
763
+ export type MetricEditReq = {
764
+ metricId: number;
765
+ type?: number;
766
+ metricName: string;
767
+ metricDescription?: string;
768
+ };
769
+ export type MetricEditRes = {
770
+ merchantMetric?: MerchantMetric;
771
+ };
772
+ export type MetricDeleteEventReq = {
773
+ metricCode: string;
774
+ externalUserId?: string;
775
+ email?: string;
776
+ userId?: number;
777
+ externalEventId: string;
778
+ };
779
+ export type MetricDeleteEventRes = {};
780
+ export type MetricNewEventReq = {
781
+ metricCode: string;
782
+ externalEventId: string;
783
+ externalUserId?: string;
784
+ email?: string;
785
+ userId?: number;
786
+ metricProperties?: any;
787
+ aggregationValue?: number;
788
+ aggregationUniqueId?: string;
789
+ productId?: number;
790
+ testCreateTime?: number;
791
+ };
792
+ export type MetricNewEventRes = {
793
+ merchantMetricEvent?: MerchantMetricEvent;
794
+ };
795
+ export type MetricEventListReq = {
796
+ userIds?: string[];
797
+ metricIds?: string[];
798
+ sortField?: string;
799
+ sortType?: string;
800
+ page?: number;
801
+ count?: number;
802
+ createTimeStart?: number;
803
+ createTimeEnd?: number;
804
+ };
805
+ export type MetricEventListRes = {
806
+ events?: string[];
807
+ total?: number;
808
+ };
809
+ export type MetricListReq = {
810
+ sortField?: string;
811
+ sortType?: string;
812
+ page?: number;
813
+ count?: number;
814
+ createTimeStart?: number;
815
+ createTimeEnd?: number;
816
+ };
817
+ export type MetricListRes = {
818
+ merchantMetrics?: string[];
819
+ total?: number;
820
+ };
821
+ export type MetricNewReq = {
822
+ code: string;
823
+ type?: number;
824
+ metricName: string;
825
+ metricDescription?: string;
826
+ aggregationType?: number;
827
+ aggregationProperty?: string;
828
+ };
829
+ export type MetricNewRes = {
830
+ merchantMetric?: MerchantMetric;
831
+ };
832
+ export type MetricDeletePlanLimitReq = {
833
+ metricPlanLimitId: number;
834
+ };
835
+ export type MetricDeletePlanLimitRes = {
836
+ merchantMetricPlanLimit?: DetailMerchantMetricPlanLimitDetail;
837
+ };
838
+ export type MetricEditPlanLimitReq = {
839
+ metricPlanLimitId: number;
840
+ metricLimit: number;
841
+ };
842
+ export type MetricEditPlanLimitRes = {
843
+ merchantMetricPlanLimit?: DetailMerchantMetricPlanLimitDetail;
844
+ };
845
+ export type MetricNewPlanLimitReq = {
846
+ metricId: number;
847
+ planId: number;
848
+ metricLimit: number;
849
+ };
850
+ export type MetricNewPlanLimitRes = {
851
+ merchantMetricPlanLimit?: DetailMerchantMetricPlanLimitDetail;
852
+ };
853
+ export type MetricUserMetricReq = {
854
+ userId?: number;
855
+ externalUserId?: string;
856
+ productId?: number;
857
+ };
858
+ export type MetricUserMetricRes = {
859
+ userMetric?: DetailUserMetric;
860
+ };
861
+ export type MetricUserSubscriptionMetricReq = {
862
+ subscriptionId?: string;
863
+ };
864
+ export type MetricUserSubscriptionMetricRes = {
865
+ userMetric?: DetailUserMetric;
866
+ };
867
+ export type OssFileUploadReq = {
868
+ file?: any;
869
+ };
870
+ export type OssFileUploadRes = {
871
+ url?: string;
872
+ };
873
+ export type PaymentCancelReq = {
874
+ paymentId: string;
875
+ };
876
+ export type PaymentCancelRes = {};
877
+ export type PaymentCaptureReq = {
878
+ paymentId: string;
879
+ externalCaptureId: string;
880
+ };
881
+ export type PaymentCaptureRes = {};
882
+ export type PaymentDetailReq = {
883
+ paymentId: string;
884
+ };
885
+ export type PaymentDetailRes = {
886
+ paymentDetail?: DetailPaymentDetail;
887
+ };
888
+ export type PaymentItemListReq = {
889
+ userId?: number;
890
+ sortField?: string;
891
+ sortType?: string;
892
+ page?: number;
893
+ count?: number;
894
+ };
895
+ export type PaymentItemListRes = {
896
+ paymentItems?: string[];
897
+ total?: number;
898
+ };
899
+ export type PaymentListReq = {
900
+ gatewayId?: number;
901
+ userId?: number;
902
+ email?: string;
903
+ status?: number;
904
+ currency?: string;
905
+ countryCode?: string;
906
+ sortField?: string;
907
+ sortType?: string;
908
+ page?: number;
909
+ count?: number;
910
+ };
911
+ export type PaymentListRes = {
912
+ paymentDetails?: string[];
913
+ total?: number;
914
+ };
915
+ export type PaymentMethodDeleteReq = {
916
+ userId: number;
917
+ gatewayId: number;
918
+ paymentMethodId: string;
919
+ };
920
+ export type PaymentMethodDeleteRes = {};
921
+ export type PaymentMethodGetReq = {
922
+ gatewayId: number;
923
+ userId: number;
924
+ paymentMethodId: string;
925
+ };
926
+ export type PaymentMethodGetRes = {
927
+ method?: PaymentMethod;
928
+ };
929
+ export type PaymentMethodListReq = {
930
+ gatewayId: number;
931
+ userId?: number;
932
+ paymentId?: string;
933
+ };
934
+ export type PaymentMethodListRes = {
935
+ methodList?: string[];
936
+ };
937
+ export type PaymentMethodNewReq = {
938
+ userId: number;
939
+ gatewayId: number;
940
+ currency?: string;
941
+ subscriptionId?: string;
942
+ redirectUrl?: string;
943
+ type?: string;
944
+ metadata?: object;
945
+ };
946
+ export type PaymentMethodNewRes = {
947
+ url?: string;
948
+ method?: PaymentMethod;
949
+ };
950
+ export type PaymentNewReq = {
951
+ externalPaymentId?: string;
952
+ externalUserId?: string;
953
+ email?: string;
954
+ userId?: number;
955
+ currency?: string;
956
+ totalAmount?: number;
957
+ planId?: number;
958
+ gatewayId: number;
959
+ gatewayPaymentType?: string;
960
+ redirectUrl?: string;
961
+ cancelUrl?: string;
962
+ countryCode?: string;
963
+ name?: string;
964
+ description?: string;
965
+ items?: string[];
966
+ metadata?: object;
967
+ gasPayer?: string;
968
+ sendInvoice?: boolean;
969
+ paymentType?: string;
970
+ };
971
+ export type PaymentItem = {
972
+ amount: number;
973
+ name?: string;
974
+ description?: string;
975
+ quantity?: number;
976
+ unitAmountExcludingTax?: number;
977
+ currency?: string;
978
+ tax?: number;
979
+ amountExcludingTax?: number;
980
+ taxPercentage?: number;
981
+ };
982
+ export type PaymentNewRes = {
983
+ status?: number;
984
+ paymentId?: string;
985
+ externalPaymentId?: string;
986
+ link?: string;
987
+ action?: any;
988
+ };
989
+ export type PaymentRefundCancelReq = {
990
+ refundId: string;
991
+ };
992
+ export type PaymentRefundCancelRes = {};
993
+ export type PaymentRefundDetailReq = {
994
+ refundId?: string;
995
+ };
996
+ export type PaymentRefundDetailRes = {
997
+ refundDetail?: DetailRefundDetail;
998
+ };
999
+ export type PaymentRefundListReq = {
1000
+ paymentId: string;
1001
+ status?: number;
1002
+ gatewayId?: number;
1003
+ userId?: number;
1004
+ email?: string;
1005
+ currency?: string;
1006
+ };
1007
+ export type PaymentRefundListRes = {
1008
+ refundDetails?: string[];
1009
+ total?: number;
1010
+ };
1011
+ export type PaymentNewPaymentRefundReq = {
1012
+ paymentId: string;
1013
+ externalRefundId: string;
1014
+ refundAmount: number;
1015
+ currency: string;
1016
+ reason?: string;
1017
+ metadata?: object;
1018
+ };
1019
+ export type PaymentNewPaymentRefundRes = {
1020
+ status?: number;
1021
+ refundId?: string;
1022
+ externalRefundId?: string;
1023
+ paymentId?: string;
1024
+ };
1025
+ export type PaymentTimeLineListReq = {
1026
+ userId?: number;
1027
+ amountStart?: number;
1028
+ amountEnd?: number;
1029
+ status?: string[];
1030
+ timelineTypes?: string[];
1031
+ gatewayIds?: string[];
1032
+ currency?: string;
1033
+ sortField?: string;
1034
+ sortType?: string;
1035
+ page?: number;
1036
+ count?: number;
1037
+ createTimeStart?: number;
1038
+ createTimeEnd?: number;
1039
+ };
1040
+ export type PaymentTimeLineListRes = {
1041
+ paymentTimeLines?: string[];
1042
+ total?: number;
1043
+ };
1044
+ export type PlanActivateReq = {
1045
+ planId: number;
1046
+ };
1047
+ export type PlanActivateRes = {};
1048
+ export type PlanAddonsBindingReq = {
1049
+ planId: number;
1050
+ action: number;
1051
+ addonIds: string[];
1052
+ onetimeAddonIds: string[];
1053
+ };
1054
+ export type PlanAddonsBindingRes = {
1055
+ plan?: Plan;
1056
+ };
1057
+ export type PlanArchiveReq = {
1058
+ planId: number;
1059
+ hardArchive?: boolean;
1060
+ };
1061
+ export type PlanArchiveRes = {};
1062
+ export type PlanCopyReq = {
1063
+ planId: number;
1064
+ };
1065
+ export type PlanCopyRes = {
1066
+ plan?: Plan;
1067
+ };
1068
+ export type PlanDeleteReq = {
1069
+ planId: number;
1070
+ };
1071
+ export type PlanDeleteRes = {};
1072
+ export type PlanDetailReq = {
1073
+ planId: number;
1074
+ };
1075
+ export type PlanDetailRes = {
1076
+ plan?: DetailPlanDetail;
1077
+ };
1078
+ export type PlanEditReq = {
1079
+ planId: number;
1080
+ externalPlanId?: string;
1081
+ planName?: string;
1082
+ amount?: number;
1083
+ currency?: string;
1084
+ intervalUnit?: string;
1085
+ intervalCount?: number;
1086
+ description?: string;
1087
+ productName?: string;
1088
+ productDescription?: string;
1089
+ imageUrl?: string;
1090
+ homeUrl?: string;
1091
+ addonIds?: string[];
1092
+ onetimeAddonIds?: string[];
1093
+ metricLimits?: string[];
1094
+ metricMeteredCharge?: string[];
1095
+ metricRecurringCharge?: string[];
1096
+ gasPayer?: string;
1097
+ metadata?: object;
1098
+ trialAmount?: number;
1099
+ trialDurationTime?: number;
1100
+ trialDemand?: string;
1101
+ cancelAtTrialEnd?: number;
1102
+ productId?: number;
1103
+ };
1104
+ export type PlanEditRes = {
1105
+ plan?: Plan;
1106
+ };
1107
+ export type PlanListReq = {
1108
+ productIds?: string[];
1109
+ type?: string[];
1110
+ status?: string[];
1111
+ publishStatus?: number;
1112
+ currency?: string;
1113
+ searchKey?: string;
1114
+ sortField?: string;
1115
+ sortType?: string;
1116
+ page?: number;
1117
+ count?: number;
1118
+ };
1119
+ export type PlanListRes = {
1120
+ plans?: string[];
1121
+ total?: number;
1122
+ };
1123
+ export type PlanNewReq = {
1124
+ externalPlanId?: string;
1125
+ planName: string;
1126
+ amount: number;
1127
+ currency: string;
1128
+ intervalUnit?: string;
1129
+ intervalCount?: number;
1130
+ description?: string;
1131
+ type?: number;
1132
+ productName?: string;
1133
+ productDescription?: string;
1134
+ imageUrl?: string;
1135
+ homeUrl?: string;
1136
+ addonIds?: string[];
1137
+ onetimeAddonIds?: string[];
1138
+ metricLimits?: string[];
1139
+ metricMeteredCharge?: string[];
1140
+ metricRecurringCharge?: string[];
1141
+ gasPayer?: string;
1142
+ metadata?: object;
1143
+ trialAmount?: number;
1144
+ trialDurationTime?: number;
1145
+ trialDemand?: string;
1146
+ cancelAtTrialEnd?: number;
1147
+ productId?: number;
1148
+ };
1149
+ export type PlanNewRes = {
1150
+ plan?: Plan;
1151
+ };
1152
+ export type PlanPublishReq = {
1153
+ planId: number;
1154
+ };
1155
+ export type PlanPublishRes = {};
1156
+ export type PlanUnPublishReq = {
1157
+ planId: number;
1158
+ };
1159
+ export type PlanUnPublishRes = {};
1160
+ export type ProductActivateReq = {
1161
+ productId: number;
1162
+ };
1163
+ export type ProductActivateRes = {};
1164
+ export type ProductCopyReq = {
1165
+ productId: number;
1166
+ };
1167
+ export type ProductCopyRes = {
1168
+ product?: Product;
1169
+ };
1170
+ export type ProductDeleteReq = {
1171
+ productId: number;
1172
+ };
1173
+ export type ProductDeleteRes = {};
1174
+ export type ProductDetailReq = {
1175
+ productId: number;
1176
+ };
1177
+ export type ProductDetailRes = {
1178
+ product?: Product;
1179
+ };
1180
+ export type ProductEditReq = {
1181
+ productId: number;
1182
+ productName?: string;
1183
+ description?: string;
1184
+ imageUrl?: string;
1185
+ homeUrl?: string;
1186
+ status?: number;
1187
+ metadata?: object;
1188
+ };
1189
+ export type ProductEditRes = {
1190
+ product?: Product;
1191
+ };
1192
+ export type ProductInactiveReq = {
1193
+ productId: number;
1194
+ };
1195
+ export type ProductInactiveRes = {};
1196
+ export type ProductListReq = {
1197
+ status?: string[];
1198
+ sortField?: string;
1199
+ sortType?: string;
1200
+ page?: number;
1201
+ count?: number;
1202
+ };
1203
+ export type ProductListRes = {
1204
+ products?: string[];
1205
+ total?: number;
1206
+ };
1207
+ export type ProductNewReq = {
1208
+ productName?: string;
1209
+ description?: string;
1210
+ imageUrl?: string;
1211
+ homeUrl?: string;
1212
+ status?: number;
1213
+ metadata?: object;
1214
+ };
1215
+ export type ProductNewRes = {
1216
+ product?: Product;
1217
+ };
1218
+ export type RoleDeleteReq = {
1219
+ id: number;
1220
+ };
1221
+ export type RoleDeleteRes = {};
1222
+ export type RoleEditReq = {
1223
+ id: number;
1224
+ role: string;
1225
+ permissions: string[];
1226
+ };
1227
+ export type RoleEditRes = {};
1228
+ export type RoleListReq = {};
1229
+ export type RoleListRes = {
1230
+ merchantRoles?: string[];
1231
+ total?: number;
1232
+ };
1233
+ export type RoleNewReq = {
1234
+ role: string;
1235
+ permissions: string[];
1236
+ };
1237
+ export type RoleNewRes = {};
1238
+ export type SearchSearchReq = {
1239
+ searchKey?: string;
1240
+ };
1241
+ export type SearchSearchRes = {
1242
+ precisionMatchObject?: SearchPrecisionMatchObject;
1243
+ matchUserAccounts?: string[];
1244
+ matchInvoice?: string[];
1245
+ };
1246
+ export type SearchPrecisionMatchObject = {
1247
+ type?: string;
1248
+ id?: string;
1249
+ data?: any;
1250
+ };
1251
+ export type SessionNewReq = {
1252
+ externalUserId: string;
1253
+ email: string;
1254
+ firstName?: string;
1255
+ lastName?: string;
1256
+ returnUrl?: string;
1257
+ password?: string;
1258
+ phone?: string;
1259
+ address?: string;
1260
+ };
1261
+ export type SessionNewRes = {
1262
+ userId?: string;
1263
+ externalUserId?: string;
1264
+ email?: string;
1265
+ url?: string;
1266
+ clientToken?: string;
1267
+ clientSession?: string;
1268
+ };
1269
+ export type SubscriptionActiveTemporarilyReq = {
1270
+ subscriptionId: string;
1271
+ expireTime: number;
1272
+ };
1273
+ export type SubscriptionActiveTemporarilyRes = {};
1274
+ export type SubscriptionAddNewTrialStartReq = {
1275
+ subscriptionId: string;
1276
+ appendTrialEndHour: number;
1277
+ };
1278
+ export type SubscriptionAddNewTrialStartRes = {};
1279
+ export type SubscriptionAdminNoteListReq = {
1280
+ subscriptionId: string;
1281
+ page?: number;
1282
+ count?: number;
1283
+ };
1284
+ export type SubscriptionAdminNoteListRes = {
1285
+ noteLists?: string[];
1286
+ };
1287
+ export type SubscriptionAdminNoteRo = {
1288
+ id?: number;
1289
+ note?: string;
1290
+ createTime?: number;
1291
+ subscriptionId?: string;
1292
+ userName?: string;
1293
+ mobile?: string;
1294
+ email?: string;
1295
+ firstName?: string;
1296
+ lastName?: string;
1297
+ };
1298
+ export type SubscriptionCancelReq = {
1299
+ subscriptionId?: string;
1300
+ userId?: number;
1301
+ productId?: number;
1302
+ reason?: string;
1303
+ invoiceNow?: boolean;
1304
+ prorate?: boolean;
1305
+ };
1306
+ export type SubscriptionCancelRes = {};
1307
+ export type SubscriptionCancelAtPeriodEndReq = {
1308
+ subscriptionId?: string;
1309
+ userId?: number;
1310
+ productId?: number;
1311
+ };
1312
+ export type SubscriptionCancelAtPeriodEndRes = {};
1313
+ export type SubscriptionCancelLastCancelAtPeriodEndReq = {
1314
+ subscriptionId?: string;
1315
+ userId?: number;
1316
+ productId?: number;
1317
+ };
1318
+ export type SubscriptionCancelLastCancelAtPeriodEndRes = {};
1319
+ export type SubscriptionChangeGatewayReq = {
1320
+ subscriptionId: string;
1321
+ gatewayId: number;
1322
+ paymentMethodId?: string;
1323
+ };
1324
+ export type SubscriptionChangeGatewayRes = {};
1325
+ export type SubscriptionConfigReq = {};
1326
+ export type SubscriptionConfigRes = {
1327
+ config?: SubscriptionConfig;
1328
+ };
1329
+ export type SubscriptionConfigUpdateReq = {
1330
+ downgradeEffectImmediately?: boolean;
1331
+ upgradeProration?: boolean;
1332
+ incompleteExpireTime?: number;
1333
+ invoiceEmail?: boolean;
1334
+ tryAutomaticPaymentBeforePeriodEnd?: number;
1335
+ gatewayVATRule?: string[];
1336
+ showZeroInvoice?: boolean;
1337
+ };
1338
+ export type SubscriptionConfigUpdateRes = {
1339
+ config?: SubscriptionConfig;
1340
+ };
1341
+ export type SubscriptionCreatePreviewReq = {
1342
+ planId: number;
1343
+ email?: string;
1344
+ userId?: number;
1345
+ externalUserId?: string;
1346
+ user?: NewUser;
1347
+ quantity?: number;
1348
+ gatewayId?: number;
1349
+ gatewayPaymentType?: string;
1350
+ addonParams?: string[];
1351
+ vatCountryCode?: string;
1352
+ vatNumber?: string;
1353
+ taxPercentage?: number;
1354
+ discountCode?: string;
1355
+ trialEnd?: number;
1356
+ applyPromoCredit?: boolean;
1357
+ applyPromoCreditAmount?: number;
1358
+ };
1359
+ export type SubscriptionCreatePreviewRes = {
1360
+ plan?: Plan;
1361
+ trialEnd?: number;
1362
+ quantity?: number;
1363
+ gateway?: DetailGateway;
1364
+ addonParams?: string[];
1365
+ addons?: string[];
1366
+ subscriptionAmountExcludingTax?: number;
1367
+ taxAmount?: number;
1368
+ discountAmount?: number;
1369
+ totalAmount?: number;
1370
+ originAmount?: number;
1371
+ currency?: string;
1372
+ invoice?: Invoice;
1373
+ userId?: number;
1374
+ email?: string;
1375
+ vatCountryCode?: string;
1376
+ vatCountryName?: string;
1377
+ taxPercentage?: number;
1378
+ vatNumber?: string;
1379
+ vatNumberValidate?: ValidResult;
1380
+ discount?: MerchantDiscountCode;
1381
+ vatNumberValidateMessage?: string;
1382
+ discountMessage?: string;
1383
+ otherPendingCryptoSubscription?: DetailSubscriptionDetail;
1384
+ otherActiveSubscriptionId?: string;
1385
+ applyPromoCredit?: boolean;
1386
+ };
1387
+ export type SubscriptionCreateReq = {
1388
+ planId: number;
1389
+ userId?: number;
1390
+ email?: string;
1391
+ externalUserId?: string;
1392
+ user?: NewUser;
1393
+ quantity?: number;
1394
+ gatewayId?: number;
1395
+ gatewayPaymentType?: string;
1396
+ addonParams?: string[];
1397
+ confirmTotalAmount?: number;
1398
+ confirmCurrency?: string;
1399
+ returnUrl?: string;
1400
+ cancelUrl?: string;
1401
+ vatCountryCode?: string;
1402
+ vatNumber?: string;
1403
+ taxPercentage?: number;
1404
+ paymentMethodId?: string;
1405
+ metadata?: object;
1406
+ discountCode?: string;
1407
+ discount?: ExternalDiscountParam;
1408
+ trialEnd?: number;
1409
+ startIncomplete?: boolean;
1410
+ productData?: PlanProductParam;
1411
+ applyPromoCredit?: boolean;
1412
+ applyPromoCreditAmount?: number;
1413
+ };
1414
+ export type SubscriptionCreateRes = {
1415
+ subscription?: Subscription;
1416
+ user?: UserAccount;
1417
+ paid?: boolean;
1418
+ link?: string;
1419
+ token?: string;
1420
+ otherPendingCryptoSubscription?: DetailSubscriptionDetail;
1421
+ };
1422
+ export type SubscriptionDetailReq = {
1423
+ subscriptionId: string;
1424
+ };
1425
+ export type SubscriptionDetailRes = {
1426
+ user?: UserAccount;
1427
+ subscription?: Subscription;
1428
+ plan?: Plan;
1429
+ gateway?: DetailGateway;
1430
+ addonParams?: string[];
1431
+ addons?: string[];
1432
+ latestInvoice?: Invoice;
1433
+ unfinishedSubscriptionPendingUpdate?: DetailSubscriptionPendingUpdateDetail;
1434
+ };
1435
+ export type SubscriptionListReq = {
1436
+ userId?: number;
1437
+ status?: string[];
1438
+ currency?: string;
1439
+ planIds?: string[];
1440
+ productIds?: string[];
1441
+ amountStart?: number;
1442
+ amountEnd?: number;
1443
+ sortField?: string;
1444
+ sortType?: string;
1445
+ page?: number;
1446
+ count?: number;
1447
+ createTimeStart?: number;
1448
+ createTimeEnd?: number;
1449
+ };
1450
+ export type SubscriptionListRes = {
1451
+ subscriptions?: string[];
1452
+ total?: number;
1453
+ };
1454
+ export type SubscriptionNewAdminNoteReq = {
1455
+ subscriptionId: string;
1456
+ note: string;
1457
+ };
1458
+ export type SubscriptionNewAdminNoteRes = {};
1459
+ export type SubscriptionOnetimeAddonNewReq = {
1460
+ subscriptionId?: string;
1461
+ userId?: number;
1462
+ addonId: number;
1463
+ quantity: number;
1464
+ returnUrl?: string;
1465
+ metadata?: object;
1466
+ discountCode?: string;
1467
+ discountAmount?: number;
1468
+ discountPercentage?: number;
1469
+ gatewayId?: number;
1470
+ taxPercentage?: number;
1471
+ };
1472
+ export type SubscriptionOnetimeAddonNewRes = {
1473
+ subscriptionOnetimeAddon?: SubscriptionOnetimeAddon;
1474
+ paid?: boolean;
1475
+ link?: string;
1476
+ invoice?: Invoice;
1477
+ };
1478
+ export type SubscriptionOnetimeAddonListReq = {
1479
+ userId: number;
1480
+ page?: number;
1481
+ count?: number;
1482
+ };
1483
+ export type SubscriptionOnetimeAddonListRes = {
1484
+ subscriptionOnetimeAddons?: string[];
1485
+ };
1486
+ export type SubscriptionNewPaymentReq = {
1487
+ externalPaymentId?: string;
1488
+ externalUserId?: string;
1489
+ email?: string;
1490
+ userId?: number;
1491
+ currency?: string;
1492
+ totalAmount?: number;
1493
+ planId?: number;
1494
+ gatewayId: number;
1495
+ redirectUrl?: string;
1496
+ cancelUrl?: string;
1497
+ countryCode?: string;
1498
+ name?: string;
1499
+ description?: string;
1500
+ items?: string[];
1501
+ metadata?: object;
1502
+ gasPayer?: string;
1503
+ };
1504
+ export type SubscriptionNewPaymentRes = {
1505
+ status?: number;
1506
+ paymentId?: string;
1507
+ externalPaymentId?: string;
1508
+ link?: string;
1509
+ action?: any;
1510
+ };
1511
+ export type SubscriptionPendingUpdateDetailReq = {
1512
+ subscriptionPendingUpdateId: string;
1513
+ };
1514
+ export type SubscriptionPendingUpdateDetailRes = {
1515
+ SubscriptionPendingUpdate?: DetailSubscriptionPendingUpdateDetail;
1516
+ };
1517
+ export type SubscriptionPendingUpdateListReq = {
1518
+ subscriptionId: string;
1519
+ sortField?: string;
1520
+ sortType?: string;
1521
+ page?: number;
1522
+ count?: number;
1523
+ };
1524
+ export type SubscriptionPendingUpdateListRes = {
1525
+ subscriptionPendingUpdateDetails?: string[];
1526
+ total?: number;
1527
+ };
1528
+ export type SubscriptionPreviewSubscriptionNextInvoiceReq = {
1529
+ subscriptionId: string;
1530
+ };
1531
+ export type SubscriptionPreviewSubscriptionNextInvoiceRes = {
1532
+ subscription?: Subscription;
1533
+ invoice?: Invoice;
1534
+ subscriptionPendingUpdate?: DetailSubscriptionPendingUpdateDetail;
1535
+ };
1536
+ export type SubscriptionRenewReq = {
1537
+ subscriptionId?: string;
1538
+ userId?: number;
1539
+ productId?: number;
1540
+ gatewayId?: number;
1541
+ gatewayPaymentType?: string;
1542
+ taxPercentage?: number;
1543
+ discountCode?: string;
1544
+ discount?: ExternalDiscountParam;
1545
+ manualPayment?: boolean;
1546
+ returnUrl?: string;
1547
+ cancelUrl?: string;
1548
+ productData?: PlanProductParam;
1549
+ metadata?: object;
1550
+ applyPromoCredit?: boolean;
1551
+ applyPromoCreditAmount?: number;
1552
+ };
1553
+ export type SubscriptionRenewRes = {
1554
+ subscription?: Subscription;
1555
+ paid?: boolean;
1556
+ link?: string;
1557
+ };
1558
+ export type SubscriptionTimeLineListReq = {
1559
+ userId?: number;
1560
+ sortField?: string;
1561
+ sortType?: string;
1562
+ page?: number;
1563
+ count?: number;
1564
+ };
1565
+ export type SubscriptionTimeLineListRes = {
1566
+ subscriptionTimeLines?: string[];
1567
+ total?: number;
1568
+ };
1569
+ export type SubscriptionUpdatePreviewReq = {
1570
+ subscriptionId: string;
1571
+ newPlanId: number;
1572
+ quantity?: number;
1573
+ gatewayId?: number;
1574
+ effectImmediate?: number;
1575
+ addonParams?: string[];
1576
+ discountCode?: string;
1577
+ applyPromoCredit?: boolean;
1578
+ applyPromoCreditAmount?: number;
1579
+ };
1580
+ export type SubscriptionUpdatePreviewRes = {
1581
+ originAmount?: number;
1582
+ totalAmount?: number;
1583
+ discountAmount?: number;
1584
+ currency?: string;
1585
+ invoice?: Invoice;
1586
+ nextPeriodInvoice?: Invoice;
1587
+ prorationDate?: number;
1588
+ discount?: MerchantDiscountCode;
1589
+ discountMessage?: string;
1590
+ applyPromoCredit?: boolean;
1591
+ };
1592
+ export type SubscriptionUpdateReq = {
1593
+ subscriptionId?: string;
1594
+ userId?: number;
1595
+ newPlanId: number;
1596
+ quantity: number;
1597
+ gatewayId?: number;
1598
+ gatewayPaymentType?: string;
1599
+ addonParams?: string[];
1600
+ effectImmediate?: number;
1601
+ confirmTotalAmount?: number;
1602
+ confirmCurrency?: string;
1603
+ prorationDate?: number;
1604
+ taxPercentage?: number;
1605
+ metadata?: object;
1606
+ discountCode?: string;
1607
+ discount?: ExternalDiscountParam;
1608
+ manualPayment?: boolean;
1609
+ returnUrl?: string;
1610
+ cancelUrl?: string;
1611
+ productData?: PlanProductParam;
1612
+ applyPromoCredit?: boolean;
1613
+ applyPromoCreditAmount?: number;
1614
+ };
1615
+ export type SubscriptionUpdateRes = {
1616
+ subscriptionPendingUpdate?: DetailSubscriptionPendingUpdateDetail;
1617
+ paid?: boolean;
1618
+ link?: string;
1619
+ note?: string;
1620
+ };
1621
+ export type SubscriptionUserPendingCryptoSubscriptionDetailReq = {
1622
+ userId?: number;
1623
+ externalUserId?: string;
1624
+ productId?: number;
1625
+ };
1626
+ export type SubscriptionUserPendingCryptoSubscriptionDetailRes = {
1627
+ subscription?: DetailSubscriptionDetail;
1628
+ };
1629
+ export type SubscriptionUserSubscriptionDetailReq = {
1630
+ userId?: number;
1631
+ externalUserId?: string;
1632
+ productId?: number;
1633
+ };
1634
+ export type SubscriptionUserSubscriptionDetailRes = {
1635
+ user?: UserAccount;
1636
+ subscription?: Subscription;
1637
+ plan?: Plan;
1638
+ gateway?: DetailGateway;
1639
+ addons?: string[];
1640
+ latestInvoice?: Invoice;
1641
+ unfinishedSubscriptionPendingUpdate?: DetailSubscriptionPendingUpdateDetail;
1642
+ };
1643
+ export type TaskDeleteTemplateReq = {
1644
+ templateId: number;
1645
+ };
1646
+ export type TaskDeleteTemplateRes = {};
1647
+ export type TaskEditTemplateReq = {
1648
+ templateId: number;
1649
+ name?: string;
1650
+ task?: string;
1651
+ payload?: object;
1652
+ exportColumns?: string[];
1653
+ format?: string;
1654
+ };
1655
+ export type TaskEditTemplateRes = {
1656
+ template?: MerchantBatchExportTemplate;
1657
+ };
1658
+ export type TaskExportColumnListReq = {
1659
+ task?: string;
1660
+ };
1661
+ export type TaskExportColumnListRes = {
1662
+ columns?: string[];
1663
+ groupColumns?: object;
1664
+ columnHeaders?: object;
1665
+ columnComments?: object;
1666
+ };
1667
+ export type TaskExportTemplateListReq = {
1668
+ task?: string;
1669
+ page?: number;
1670
+ count?: number;
1671
+ };
1672
+ export type TaskExportTemplateListRes = {
1673
+ templates?: string[];
1674
+ total?: number;
1675
+ };
1676
+ export type TaskListReq = {
1677
+ page?: number;
1678
+ count?: number;
1679
+ };
1680
+ export type TaskListRes = {
1681
+ downloads?: string[];
1682
+ total?: number;
1683
+ };
1684
+ export type TaskNewReq = {
1685
+ task: string;
1686
+ payload?: object;
1687
+ exportColumns?: string[];
1688
+ format?: string;
1689
+ };
1690
+ export type TaskNewRes = {};
1691
+ export type TaskNewTemplateReq = {
1692
+ name: string;
1693
+ task: string;
1694
+ payload?: object;
1695
+ exportColumns?: string[];
1696
+ format?: string;
1697
+ };
1698
+ export type TaskNewTemplateRes = {
1699
+ template?: MerchantBatchExportTemplate;
1700
+ };
1701
+ export type TaskNewImportReq = {
1702
+ file: any;
1703
+ task: string;
1704
+ };
1705
+ export type TaskNewImportRes = {};
1706
+ export type TrackSetupSegmentReq = {
1707
+ serverSideSecret: string;
1708
+ userPortalSecret: string;
1709
+ };
1710
+ export type TrackSetupSegmentRes = {};
1711
+ export type UserAdminNoteListReq = {
1712
+ userId: number;
1713
+ page?: number;
1714
+ count?: number;
1715
+ };
1716
+ export type UserAdminNoteListRes = {
1717
+ noteLists?: string[];
1718
+ };
1719
+ export type UserChangeEmailReq = {
1720
+ userId?: number;
1721
+ externalUserId?: string;
1722
+ newEmail: string;
1723
+ };
1724
+ export type UserChangeEmailRes = {};
1725
+ export type UserChangeGatewayReq = {
1726
+ userId: number;
1727
+ gatewayId: number;
1728
+ gatewayPaymentType?: string;
1729
+ gatewayUserId?: string;
1730
+ paymentMethodId?: string;
1731
+ };
1732
+ export type UserChangeGatewayRes = {};
1733
+ export type UserClearAutoChargeMethodReq = {
1734
+ userId: number;
1735
+ };
1736
+ export type UserClearAutoChargeMethodRes = {};
1737
+ export type UserGetReq = {
1738
+ userId?: number;
1739
+ };
1740
+ export type UserGetRes = {
1741
+ user?: DetailUserAccountDetail;
1742
+ };
1743
+ export type UserListReq = {
1744
+ userId?: number;
1745
+ firstName?: string;
1746
+ lastName?: string;
1747
+ email?: string;
1748
+ planIds?: string[];
1749
+ subscriptionId?: string;
1750
+ subStatus?: string[];
1751
+ status?: string[];
1752
+ deleteInclude?: boolean;
1753
+ sortField?: string;
1754
+ sortType?: string;
1755
+ page?: number;
1756
+ count?: number;
1757
+ createTimeStart?: number;
1758
+ createTimeEnd?: number;
1759
+ };
1760
+ export type UserListRes = {
1761
+ userAccounts?: string[];
1762
+ total?: number;
1763
+ };
1764
+ export type UserNewReq = {
1765
+ externalUserId?: string;
1766
+ email: string;
1767
+ firstName?: string;
1768
+ lastName?: string;
1769
+ password?: string;
1770
+ phone?: string;
1771
+ address?: string;
1772
+ language?: string;
1773
+ };
1774
+ export type UserNewRes = {
1775
+ user?: UserAccount;
1776
+ };
1777
+ export type UserNewAdminNoteReq = {
1778
+ userId: number;
1779
+ note: string;
1780
+ };
1781
+ export type UserNewAdminNoteRes = {};
1782
+ export type UserReleaseReq = {
1783
+ userId?: number;
1784
+ };
1785
+ export type UserReleaseRes = {};
1786
+ export type UserSearchReq = {
1787
+ searchKey?: string;
1788
+ };
1789
+ export type UserSearchRes = {
1790
+ userAccounts?: string[];
1791
+ };
1792
+ export type UserFrozenReq = {
1793
+ userId?: number;
1794
+ };
1795
+ export type UserFrozenRes = {};
1796
+ export type UserUpdateReq = {
1797
+ userId?: number;
1798
+ email?: string;
1799
+ firstName?: string;
1800
+ lastName?: string;
1801
+ address?: string;
1802
+ companyName?: string;
1803
+ vATNumber?: string;
1804
+ registrationNumber?: string;
1805
+ phone?: string;
1806
+ telegram?: string;
1807
+ whatsApp?: string;
1808
+ weChat?: string;
1809
+ LinkedIn?: string;
1810
+ facebook?: string;
1811
+ tiktok?: string;
1812
+ otherSocialInfo?: string;
1813
+ countryCode?: string;
1814
+ countryName?: string;
1815
+ type?: number;
1816
+ gatewayId?: number;
1817
+ gatewayPaymentType?: string;
1818
+ paymentMethodId?: string;
1819
+ city?: string;
1820
+ zipCode?: string;
1821
+ language?: string;
1822
+ externalUserId?: string;
1823
+ metadata?: object;
1824
+ };
1825
+ export type UserUpdateRes = {
1826
+ user?: DetailUserAccountDetail;
1827
+ };
1828
+ export type UserWalletListReq = {
1829
+ userId: number;
1830
+ };
1831
+ export type UserWalletListRes = {
1832
+ wallet_list?: string[];
1833
+ };
1834
+ export type UserWalletNewChargeReq = {
1835
+ userId: number;
1836
+ currency: string;
1837
+ amount: number;
1838
+ note: string;
1839
+ };
1840
+ export type UserWalletNewChargeRes = {
1841
+ wallet?: UserWallet;
1842
+ };
1843
+ export type UserWalletTimelineReq = {
1844
+ userId?: number;
1845
+ reason?: string[];
1846
+ note?: string;
1847
+ sortField?: string;
1848
+ sortType?: string;
1849
+ page?: number;
1850
+ count?: number;
1851
+ createTimeStart?: number;
1852
+ createTimeEnd?: number;
1853
+ };
1854
+ export type UserWalletTimelineRes = {
1855
+ wallet_timeline?: string[];
1856
+ total?: number;
1857
+ };
1858
+ export type VatCountryListReq = {};
1859
+ export type VatCountryListRes = {
1860
+ vatCountryList?: string[];
1861
+ };
1862
+ export type VatInitDefaultGatewayReq = {};
1863
+ export type VatInitDefaultGatewayRes = {};
1864
+ export type VatSetupGatewayReq = {
1865
+ gatewayName: string;
1866
+ data: string;
1867
+ IsDefault?: boolean;
1868
+ };
1869
+ export type VatSetupGatewayRes = {
1870
+ data?: string;
1871
+ };
1872
+ export type VatNumberValidateReq = {
1873
+ vatNumber: string;
1874
+ };
1875
+ export type VatNumberValidateRes = {
1876
+ vatNumberValidate?: ValidResult;
1877
+ };
1878
+ export type WebhookDeleteEndpointReq = {
1879
+ endpointId: number;
1880
+ };
1881
+ export type WebhookDeleteEndpointRes = {};
1882
+ export type WebhookEndpointListReq = {};
1883
+ export type WebhookEndpointListRes = {
1884
+ endpointList?: string[];
1885
+ };
1886
+ export type WebhookEndpointLogListReq = {
1887
+ endpointId: number;
1888
+ page?: number;
1889
+ count?: number;
1890
+ };
1891
+ export type WebhookEndpointLogListRes = {
1892
+ endpointLogList?: string[];
1893
+ total?: number;
1894
+ };
1895
+ export type WebhookEventListReq = {};
1896
+ export type WebhookEventListRes = {
1897
+ eventList?: string[];
1898
+ };
1899
+ export type WebhookNewEndpointReq = {
1900
+ url: string;
1901
+ events?: string[];
1902
+ };
1903
+ export type WebhookNewEndpointRes = {};
1904
+ export type WebhookResendWebhookReq = {
1905
+ logId: number;
1906
+ };
1907
+ export type WebhookResendWebhookRes = {
1908
+ sendResult?: boolean;
1909
+ };
1910
+ export type WebhookUpdateEndpointReq = {
1911
+ endpointId: number;
1912
+ url: string;
1913
+ events?: string[];
1914
+ };
1915
+ export type WebhookUpdateEndpointRes = {};
1916
+ //# sourceMappingURL=merchant.d.ts.map