@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.
- package/README.md +31 -0
- package/dist/apiClient.d.ts +19 -0
- package/dist/apiClient.d.ts.map +1 -0
- package/dist/apiClient.js +46 -0
- package/dist/apiClient.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -0
- package/dist/merchant.d.ts +2144 -0
- package/dist/merchant.d.ts.map +1 -0
- package/dist/merchant.js +1819 -0
- package/dist/merchant.js.map +1 -0
- package/dist/system.d.ts +94 -0
- package/dist/system.d.ts.map +1 -0
- package/dist/system.js +100 -0
- package/dist/system.js.map +1 -0
- package/dist/types/edm.d.ts +26 -0
- package/dist/types/edm.d.ts.map +1 -0
- package/dist/types/edm.js +3 -0
- package/dist/types/edm.js.map +1 -0
- package/dist/types/interface.d.ts +8 -0
- package/dist/types/interface.d.ts.map +1 -0
- package/dist/types/interface.js +3 -0
- package/dist/types/interface.js.map +1 -0
- package/dist/types/merchant.d.ts +1916 -0
- package/dist/types/merchant.d.ts.map +1 -0
- package/dist/types/merchant.js +3 -0
- package/dist/types/merchant.js.map +1 -0
- package/dist/types/shared.d.ts +1211 -0
- package/dist/types/shared.d.ts.map +1 -0
- package/dist/types/shared.js +3 -0
- package/dist/types/shared.js.map +1 -0
- package/dist/types/system.d.ts +78 -0
- package/dist/types/system.d.ts.map +1 -0
- package/dist/types/system.js +3 -0
- package/dist/types/system.js.map +1 -0
- package/dist/types/user.d.ts +491 -0
- package/dist/types/user.d.ts.map +1 -0
- package/dist/types/user.js +3 -0
- package/dist/types/user.js.map +1 -0
- package/dist/user.d.ts +589 -0
- package/dist/user.d.ts.map +1 -0
- package/dist/user.js +466 -0
- package/dist/user.js.map +1 -0
- package/package.json +76 -0
|
@@ -0,0 +1,2144 @@
|
|
|
1
|
+
import ApiClient from './apiClient';
|
|
2
|
+
import { AuthLoginReq, AuthLoginOtpReq, AuthLoginOtpVerifyReq, AuthPasswordForgetOtpReq, AuthPasswordForgetOtpVerifyReq, AuthPasswordSetupOtpReq, AuthRegisterReq, AuthRegisterVerifyReq, ProfileCountryConfigListReq, CreditConfigListReq, CreditCreditTransactionListReq, CreditDetailReq, CreditEditConfigReq, CreditEditCreditAccountReq, CreditEditPromoConfigReq, CreditPromoConfigReq, CreditPromoConfigStatisticsReq, CreditNewConfigReq, CreditNewCreditRechargeReq, CreditPromoCreditDecrementReq, CreditPromoCreditIncrementReq, DiscountActivateReq, DiscountDeactivateReq, DiscountQuantityDecrementReq, DiscountDeleteReq, DiscountDetailReq, DiscountEditReq, DiscountNewReq, DiscountPlanApplyPreviewReq, DiscountQuantityIncrementReq, ProfileEditCountryConfigReq, EdmSetupGatewayReq, EmailCustomizeLocalizationTemplateSyncReq, EmailSenderSetupReq, EmailGatewaySetupReq, EmailSendTemplateEmailToUserReq, EmailTemplateActivateReq, EmailTemplateDeactivateReq, EmailTemplateSetDefaultReq, EmailTemplateUpdateReq, GatewayArchiveReq, GatewayDetailReq, GatewayEditReq, GatewayEditCountryConfigReq, GatewayEditSortReq, GatewaySetupReq, GatewaySetupExchangeApiReq, GatewaySetupWebhookReq, GatewayWireTransferEditReq, GatewayWireTransferSetupReq, InvoiceCancelReq, InvoiceDeleteReq, InvoiceDetailReq, InvoiceEditReq, InvoiceFinishReq, InvoiceListReq, InvoiceMarkRefundReq, InvoiceMarkRefundInvoiceSuccessReq, InvoiceMarkWireTransferSuccessReq, InvoiceNewReq, InvoicePdfGenerateReq, InvoicePdfUpdateReq, InvoiceReconvertCryptoAndSendReq, InvoiceRefundReq, InvoiceSendEmailReq, MemberListReq, MemberLogoutReq, MemberNewMemberReq, MemberPasswordResetReq, MemberReleaseReq, MemberFrozenReq, MemberUpdateReq, MemberUpdateMemberRoleReq, MetricDeleteReq, MetricDetailReq, MetricEditReq, MetricDeleteEventReq, MetricNewEventReq, MetricEventListReq, MetricListReq, MetricNewReq, MetricDeletePlanLimitReq, MetricEditPlanLimitReq, MetricNewPlanLimitReq, ProfileNewApiKeyReq, PaymentCancelReq, PaymentCaptureReq, PaymentMethodDeleteReq, PaymentMethodNewReq, PaymentNewReq, PaymentRefundCancelReq, PaymentNewPaymentRefundReq, PaymentTimeLineListReq, PlanActivateReq, PlanAddonsBindingReq, PlanArchiveReq, PlanCopyReq, PlanDeleteReq, PlanDetailReq, PlanEditReq, PlanListReq, PlanNewReq, PlanPublishReq, PlanUnPublishReq, ProductActivateReq, ProductCopyReq, ProductDeleteReq, ProductDetailReq, ProductEditReq, ProductInactiveReq, ProductListReq, ProductNewReq, RoleDeleteReq, RoleEditReq, RoleNewReq, SearchPrecisionMatchObject, SearchSearchReq, SessionNewReq, SubscriptionActiveTemporarilyReq, SubscriptionAddNewTrialStartReq, SubscriptionAdminNoteRo, SubscriptionAdminNoteListReq, SubscriptionCancelReq, SubscriptionCancelAtPeriodEndReq, SubscriptionCancelLastCancelAtPeriodEndReq, SubscriptionChangeGatewayReq, SubscriptionConfigUpdateReq, SubscriptionCreatePreviewReq, SubscriptionCreateReq, SubscriptionDetailReq, SubscriptionListReq, SubscriptionNewAdminNoteReq, SubscriptionOnetimeAddonNewReq, SubscriptionNewPaymentReq, SubscriptionPendingUpdateListReq, SubscriptionRenewReq, SubscriptionTimeLineListReq, SubscriptionUpdatePreviewReq, SubscriptionUpdateReq, SubscriptionUserPendingCryptoSubscriptionDetailReq, SubscriptionUserSubscriptionDetailReq, TaskDeleteTemplateReq, TaskEditTemplateReq, TaskExportColumnListReq, TaskExportTemplateListReq, TaskListReq, TaskNewReq, TaskNewTemplateReq, TrackSetupSegmentReq, ProfileUpdateReq, UserAdminNoteListReq, UserChangeEmailReq, UserChangeGatewayReq, UserClearAutoChargeMethodReq, UserListReq, UserNewReq, UserNewAdminNoteReq, UserReleaseReq, UserSearchReq, UserFrozenReq, UserUpdateReq, UserWalletListReq, UserWalletNewChargeReq, UserWalletTimelineReq, VatCountryListReq, VatInitDefaultGatewayReq, VatSetupGatewayReq, VatNumberValidateReq, WebhookDeleteEndpointReq, WebhookNewEndpointReq, WebhookResendWebhookReq, WebhookUpdateEndpointReq } from "./types/merchant";
|
|
3
|
+
import { DetailMerchantMemberDetail, MerchantCountryConfig, CreditConfig, DetailCreditAccountDetail, DetailCreditTransactionDetail, CreditTransaction, CreditAccount, CreditConfigStatistics, UserAccount, Merchant, DetailGateway, CreditRecharge, Invoice, Payment, MerchantDiscountCode, DetailMerchantDiscountCodeDetail, DetailMerchantUserDiscountCodeDetail, MerchantEmailTemplate, Currency, Sender, MerchantRole, DetailInvoiceDetail, Refund, DetailMerchantOperationLogDetail, MerchantMetric, MerchantMetricEvent, DetailMerchantMetricEventDetail, DetailMerchantMetricPlanLimitDetail, DetailUserMetric, DetailPaymentDetail, PaymentItem, PaymentMethod, DetailRefundDetail, DetailPaymentTimelineDetail, Plan, DetailPlanDetail, Product, DetailUserAccountDetail, SubscriptionConfig, PlanAddonParam, PlanAddonDetail, ValidResult, DetailSubscriptionDetail, Subscription, DetailSubscriptionPendingUpdateDetail, SubscriptionOnetimeAddon, DetailSubscriptionOnetimeAddonDetail, DetailSubscriptionTimeLineDetail, MerchantBatchExportTemplate, MerchantBatchTask, DetailUserAdminNoteDetail, UserWallet, UserWalletTimeline, VatCountryRate, MerchantWebhookEndpoint, MerchantWebhookLog } from "./types/shared";
|
|
4
|
+
import { SbisOrgData } from "./types/edm";
|
|
5
|
+
export default class MerchantApi extends ApiClient {
|
|
6
|
+
/**
|
|
7
|
+
* Password Login
|
|
8
|
+
* @schema AuthLoginReq
|
|
9
|
+
*/
|
|
10
|
+
authSsoLogin(body: AuthLoginReq): Promise<import("./types/shared").StdResponse<{
|
|
11
|
+
merchantMember: DetailMerchantMemberDetail;
|
|
12
|
+
token: string;
|
|
13
|
+
}>>;
|
|
14
|
+
/**
|
|
15
|
+
* OTP Login
|
|
16
|
+
* @schema AuthLoginOtpReq
|
|
17
|
+
*/
|
|
18
|
+
authSsoLoginOtp(body: AuthLoginOtpReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
19
|
+
/**
|
|
20
|
+
* OTP Login Code Verification
|
|
21
|
+
* @schema AuthLoginOtpVerifyReq
|
|
22
|
+
*/
|
|
23
|
+
authSsoLoginOtpVerify(body: AuthLoginOtpVerifyReq): Promise<import("./types/shared").StdResponse<{
|
|
24
|
+
merchantMember: DetailMerchantMemberDetail;
|
|
25
|
+
token: string;
|
|
26
|
+
}>>;
|
|
27
|
+
/**
|
|
28
|
+
* OTP Password Forget
|
|
29
|
+
* @schema AuthPasswordForgetOtpReq
|
|
30
|
+
*/
|
|
31
|
+
authSsoPasswordForgetOtp(body: AuthPasswordForgetOtpReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
32
|
+
/**
|
|
33
|
+
* OTP Password Forget Code Verification
|
|
34
|
+
* @schema AuthPasswordForgetOtpVerifyReq
|
|
35
|
+
*/
|
|
36
|
+
authSsoPasswordForgetOtpVerify(body: AuthPasswordForgetOtpVerifyReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
37
|
+
/**
|
|
38
|
+
* Password Setup
|
|
39
|
+
* @schema AuthPasswordSetupOtpReq
|
|
40
|
+
*/
|
|
41
|
+
authSsoPasswordSetup(body: AuthPasswordSetupOtpReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
42
|
+
/**
|
|
43
|
+
* Register
|
|
44
|
+
* @schema AuthRegisterReq
|
|
45
|
+
*/
|
|
46
|
+
authSsoRegister(body: AuthRegisterReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
47
|
+
/**
|
|
48
|
+
* Register Verify
|
|
49
|
+
* @schema AuthRegisterVerifyReq
|
|
50
|
+
*/
|
|
51
|
+
authSsoRegisterVerify(body: AuthRegisterVerifyReq): Promise<import("./types/shared").StdResponse<{
|
|
52
|
+
merchantMember: DetailMerchantMemberDetail;
|
|
53
|
+
}>>;
|
|
54
|
+
/**
|
|
55
|
+
* Edit Country Config
|
|
56
|
+
* @schema ProfileCountryConfigListReq
|
|
57
|
+
*/
|
|
58
|
+
countryConfigList(body: ProfileCountryConfigListReq): Promise<import("./types/shared").StdResponse<{
|
|
59
|
+
configs: MerchantCountryConfig[];
|
|
60
|
+
}>>;
|
|
61
|
+
/**
|
|
62
|
+
* Get Credit Config list
|
|
63
|
+
* @types number[] type list of credit account, 1-main account, 2-promo credit account
|
|
64
|
+
* @currency string currency
|
|
65
|
+
*/
|
|
66
|
+
getCreditConfigList(params: {
|
|
67
|
+
types?: number[];
|
|
68
|
+
currency?: string;
|
|
69
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
70
|
+
creditConfigs: CreditConfig[];
|
|
71
|
+
}>>;
|
|
72
|
+
/**
|
|
73
|
+
* Get Credit Config list
|
|
74
|
+
* @schema CreditConfigListReq
|
|
75
|
+
*/
|
|
76
|
+
creditConfigList(body: CreditConfigListReq): Promise<import("./types/shared").StdResponse<{
|
|
77
|
+
creditConfigs: CreditConfig[];
|
|
78
|
+
}>>;
|
|
79
|
+
/**
|
|
80
|
+
* Get Credit Account List
|
|
81
|
+
* @userId number filter id of user
|
|
82
|
+
* @email string filter email of user
|
|
83
|
+
* @sortField string Sort Field,gmt_create|gmt_modify,Default gmt_modify
|
|
84
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
85
|
+
* @page number Page, Start 0
|
|
86
|
+
* @count number Count Of Per Page
|
|
87
|
+
* @createTimeStart number CreateTimeStart
|
|
88
|
+
* @createTimeEnd number CreateTimeEnd
|
|
89
|
+
*/
|
|
90
|
+
getCreditCreditAccountList(params: {
|
|
91
|
+
userId?: number;
|
|
92
|
+
email?: string;
|
|
93
|
+
sortField?: string;
|
|
94
|
+
sortType?: string;
|
|
95
|
+
page?: number;
|
|
96
|
+
count?: number;
|
|
97
|
+
createTimeStart?: number;
|
|
98
|
+
createTimeEnd?: number;
|
|
99
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
100
|
+
creditAccounts: DetailCreditAccountDetail[];
|
|
101
|
+
total: number;
|
|
102
|
+
}>>;
|
|
103
|
+
/**
|
|
104
|
+
* Get Credit Transaction List
|
|
105
|
+
* @accountType number filter type of account, 1-main account, 2-promo credit account
|
|
106
|
+
* @userId number filter id of user
|
|
107
|
+
* @email string filter email of user
|
|
108
|
+
* @currency string filter currency of account
|
|
109
|
+
* @sortField string Sort Field,gmt_create|gmt_modify,Default gmt_modify
|
|
110
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
111
|
+
* @transactionTypes number[] transaction type。1-recharge income,2-payment out,3-refund income,4-withdraw out,5-withdraw failed income, 6-admin change,7-recharge refund out
|
|
112
|
+
* @page number Page, Start 0
|
|
113
|
+
* @count number Count Of Per Page
|
|
114
|
+
* @createTimeStart number CreateTimeStart
|
|
115
|
+
* @createTimeEnd number CreateTimeEnd
|
|
116
|
+
*/
|
|
117
|
+
getCreditCreditTransactionList(params: {
|
|
118
|
+
accountType?: number;
|
|
119
|
+
userId?: number;
|
|
120
|
+
email?: string;
|
|
121
|
+
currency?: string;
|
|
122
|
+
sortField?: string;
|
|
123
|
+
sortType?: string;
|
|
124
|
+
transactionTypes?: number[];
|
|
125
|
+
page?: number;
|
|
126
|
+
count?: number;
|
|
127
|
+
createTimeStart?: number;
|
|
128
|
+
createTimeEnd?: number;
|
|
129
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
130
|
+
creditTransactions: DetailCreditTransactionDetail[];
|
|
131
|
+
total: number;
|
|
132
|
+
}>>;
|
|
133
|
+
/**
|
|
134
|
+
* Get Credit Transaction List
|
|
135
|
+
* @schema CreditCreditTransactionListReq
|
|
136
|
+
*/
|
|
137
|
+
creditCreditTransactionList(body: CreditCreditTransactionListReq): Promise<import("./types/shared").StdResponse<{
|
|
138
|
+
creditTransactions: DetailCreditTransactionDetail[];
|
|
139
|
+
total: number;
|
|
140
|
+
}>>;
|
|
141
|
+
/**
|
|
142
|
+
* Credit Account Detail
|
|
143
|
+
* @id number The credit account Id
|
|
144
|
+
*/
|
|
145
|
+
getCreditDetail(params: {
|
|
146
|
+
id?: number;
|
|
147
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
148
|
+
creditAccount: DetailCreditAccountDetail;
|
|
149
|
+
creditTransactions: CreditTransaction[];
|
|
150
|
+
}>>;
|
|
151
|
+
/**
|
|
152
|
+
* Credit Account Detail
|
|
153
|
+
* @schema CreditDetailReq
|
|
154
|
+
*/
|
|
155
|
+
creditDetail(body: CreditDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
156
|
+
creditAccount: DetailCreditAccountDetail;
|
|
157
|
+
creditTransactions: CreditTransaction[];
|
|
158
|
+
}>>;
|
|
159
|
+
/**
|
|
160
|
+
* Edit Credit Config
|
|
161
|
+
* @schema CreditEditConfigReq
|
|
162
|
+
*/
|
|
163
|
+
creditEditConfig(body: CreditEditConfigReq): Promise<import("./types/shared").StdResponse<{
|
|
164
|
+
creditConfig: CreditConfig;
|
|
165
|
+
}>>;
|
|
166
|
+
/**
|
|
167
|
+
* Edit User Credit Account Config
|
|
168
|
+
* @schema CreditEditCreditAccountReq
|
|
169
|
+
*/
|
|
170
|
+
creditEditCreditAccount(body: CreditEditCreditAccountReq): Promise<import("./types/shared").StdResponse<{
|
|
171
|
+
UserCreditAccount: CreditAccount;
|
|
172
|
+
}>>;
|
|
173
|
+
/**
|
|
174
|
+
* Edit Promo Credit Config
|
|
175
|
+
* @schema CreditEditPromoConfigReq
|
|
176
|
+
*/
|
|
177
|
+
creditEditPromoConfig(body: CreditEditPromoConfigReq): Promise<import("./types/shared").StdResponse<{
|
|
178
|
+
creditConfig: CreditConfig;
|
|
179
|
+
}>>;
|
|
180
|
+
/**
|
|
181
|
+
* Get Promo Credit Config
|
|
182
|
+
* @currency string currency
|
|
183
|
+
*/
|
|
184
|
+
getCreditGetPromoConfig(params: {
|
|
185
|
+
currency?: string;
|
|
186
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
187
|
+
creditConfig: CreditConfig;
|
|
188
|
+
}>>;
|
|
189
|
+
/**
|
|
190
|
+
* Get Promo Credit Config
|
|
191
|
+
* @schema CreditPromoConfigReq
|
|
192
|
+
*/
|
|
193
|
+
creditGetPromoConfig(body: CreditPromoConfigReq): Promise<import("./types/shared").StdResponse<{
|
|
194
|
+
creditConfig: CreditConfig;
|
|
195
|
+
}>>;
|
|
196
|
+
/**
|
|
197
|
+
* Get Promo Credit Config Statistics
|
|
198
|
+
* @currency string currency
|
|
199
|
+
*/
|
|
200
|
+
getCreditGetPromoConfigStatistics(params: {
|
|
201
|
+
currency?: string;
|
|
202
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
203
|
+
creditConfigStatistics: CreditConfigStatistics;
|
|
204
|
+
}>>;
|
|
205
|
+
/**
|
|
206
|
+
* Get Promo Credit Config Statistics
|
|
207
|
+
* @schema CreditPromoConfigStatisticsReq
|
|
208
|
+
*/
|
|
209
|
+
creditGetPromoConfigStatistics(body: CreditPromoConfigStatisticsReq): Promise<import("./types/shared").StdResponse<{
|
|
210
|
+
creditConfigStatistics: CreditConfigStatistics;
|
|
211
|
+
}>>;
|
|
212
|
+
/**
|
|
213
|
+
* Setup Credit Config
|
|
214
|
+
* @schema CreditNewConfigReq
|
|
215
|
+
*/
|
|
216
|
+
creditNewConfig(body: CreditNewConfigReq): Promise<import("./types/shared").StdResponse<{
|
|
217
|
+
creditConfig: CreditConfig;
|
|
218
|
+
}>>;
|
|
219
|
+
/**
|
|
220
|
+
* New Credit Recharge
|
|
221
|
+
* @schema CreditNewCreditRechargeReq
|
|
222
|
+
*/
|
|
223
|
+
creditNewCreditRecharge(body: CreditNewCreditRechargeReq): Promise<import("./types/shared").StdResponse<{
|
|
224
|
+
user: UserAccount;
|
|
225
|
+
merchant: Merchant;
|
|
226
|
+
gateway: DetailGateway;
|
|
227
|
+
creditAccount: CreditAccount;
|
|
228
|
+
creditRecharge: CreditRecharge;
|
|
229
|
+
invoice: Invoice;
|
|
230
|
+
payment: Payment;
|
|
231
|
+
link: string;
|
|
232
|
+
paid: boolean;
|
|
233
|
+
}>>;
|
|
234
|
+
/**
|
|
235
|
+
* Promo Credit Decrement
|
|
236
|
+
* @schema CreditPromoCreditDecrementReq
|
|
237
|
+
*/
|
|
238
|
+
creditPromoCreditDecrement(body: CreditPromoCreditDecrementReq): Promise<import("./types/shared").StdResponse<{
|
|
239
|
+
UserPromoCreditAccount: CreditAccount;
|
|
240
|
+
}>>;
|
|
241
|
+
/**
|
|
242
|
+
* Promo Credit Increment
|
|
243
|
+
* @schema CreditPromoCreditIncrementReq
|
|
244
|
+
*/
|
|
245
|
+
creditPromoCreditIncrement(body: CreditPromoCreditIncrementReq): Promise<import("./types/shared").StdResponse<{
|
|
246
|
+
UserPromoCreditAccount: CreditAccount;
|
|
247
|
+
}>>;
|
|
248
|
+
/**
|
|
249
|
+
* Activate Discount Code
|
|
250
|
+
* @schema DiscountActivateReq
|
|
251
|
+
*/
|
|
252
|
+
discountActivate(body: DiscountActivateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
253
|
+
/**
|
|
254
|
+
* Deactivate Discount Code
|
|
255
|
+
* @schema DiscountDeactivateReq
|
|
256
|
+
*/
|
|
257
|
+
discountDeactivate(body: DiscountDeactivateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
258
|
+
/**
|
|
259
|
+
* Quantity Decrement
|
|
260
|
+
* @schema DiscountQuantityDecrementReq
|
|
261
|
+
*/
|
|
262
|
+
discountDecreaseQuantity(body: DiscountQuantityDecrementReq): Promise<import("./types/shared").StdResponse<{
|
|
263
|
+
discountCode: MerchantDiscountCode;
|
|
264
|
+
}>>;
|
|
265
|
+
/**
|
|
266
|
+
* Delete Discount Code
|
|
267
|
+
* @schema DiscountDeleteReq
|
|
268
|
+
*/
|
|
269
|
+
discountDelete(body: DiscountDeleteReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
270
|
+
/**
|
|
271
|
+
* Get Merchant Discount Detail
|
|
272
|
+
* @id number The discount's Id
|
|
273
|
+
*/
|
|
274
|
+
getDiscountDetail(params: {
|
|
275
|
+
id?: number;
|
|
276
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
277
|
+
discount: DetailMerchantDiscountCodeDetail;
|
|
278
|
+
}>>;
|
|
279
|
+
/**
|
|
280
|
+
* Get Merchant Discount Detail
|
|
281
|
+
* @schema DiscountDetailReq
|
|
282
|
+
*/
|
|
283
|
+
discountDetail(body: DiscountDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
284
|
+
discount: DetailMerchantDiscountCodeDetail;
|
|
285
|
+
}>>;
|
|
286
|
+
/**
|
|
287
|
+
* Edit Discount Code
|
|
288
|
+
* @schema DiscountEditReq
|
|
289
|
+
*/
|
|
290
|
+
discountEdit(body: DiscountEditReq): Promise<import("./types/shared").StdResponse<{
|
|
291
|
+
discount: MerchantDiscountCode;
|
|
292
|
+
}>>;
|
|
293
|
+
/**
|
|
294
|
+
* Get Discount Code List
|
|
295
|
+
* @discountType number[] discount_type, 1-percentage, 2-fixed_amount
|
|
296
|
+
* @billingType number[] billing_type, 1-one-time, 2-recurring
|
|
297
|
+
* @status number[] status, 1-editable, 2-active, 3-deactive, 4-expire, 10-archive
|
|
298
|
+
* @code string Filter Code
|
|
299
|
+
* @searchKey string Search Key, code or name
|
|
300
|
+
* @currency string Filter Currency
|
|
301
|
+
* @sortField string Sort Field,gmt_create|gmt_modify,Default gmt_modify
|
|
302
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
303
|
+
* @page number Page, Start 0
|
|
304
|
+
* @count number Count Of Per Page
|
|
305
|
+
* @createTimeStart number CreateTimeStart
|
|
306
|
+
* @createTimeEnd number CreateTimeEnd
|
|
307
|
+
*/
|
|
308
|
+
getDiscountList(params: {
|
|
309
|
+
discountType?: number[];
|
|
310
|
+
billingType?: number[];
|
|
311
|
+
status?: number[];
|
|
312
|
+
code?: string;
|
|
313
|
+
searchKey?: string;
|
|
314
|
+
currency?: string;
|
|
315
|
+
sortField?: string;
|
|
316
|
+
sortType?: string;
|
|
317
|
+
page?: number;
|
|
318
|
+
count?: number;
|
|
319
|
+
createTimeStart?: number;
|
|
320
|
+
createTimeEnd?: number;
|
|
321
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
322
|
+
discounts: DetailMerchantDiscountCodeDetail[];
|
|
323
|
+
total: number;
|
|
324
|
+
}>>;
|
|
325
|
+
/**
|
|
326
|
+
* New Discount Code
|
|
327
|
+
* @schema DiscountNewReq
|
|
328
|
+
*/
|
|
329
|
+
discountNew(body: DiscountNewReq): Promise<import("./types/shared").StdResponse<{
|
|
330
|
+
discount: MerchantDiscountCode;
|
|
331
|
+
}>>;
|
|
332
|
+
/**
|
|
333
|
+
* Plan Apply Preview
|
|
334
|
+
* @schema DiscountPlanApplyPreviewReq
|
|
335
|
+
*/
|
|
336
|
+
discountPlanApplyPreview(body: DiscountPlanApplyPreviewReq): Promise<import("./types/shared").StdResponse<{
|
|
337
|
+
valid: boolean;
|
|
338
|
+
discountAmount: number;
|
|
339
|
+
discountCode: MerchantDiscountCode;
|
|
340
|
+
failureReason: string;
|
|
341
|
+
}>>;
|
|
342
|
+
/**
|
|
343
|
+
* Quantity Increment
|
|
344
|
+
* @schema DiscountQuantityIncrementReq
|
|
345
|
+
*/
|
|
346
|
+
discountQuantityIncrement(body: DiscountQuantityIncrementReq): Promise<import("./types/shared").StdResponse<{
|
|
347
|
+
discountCode: MerchantDiscountCode;
|
|
348
|
+
}>>;
|
|
349
|
+
/**
|
|
350
|
+
* Get User Discount Code List
|
|
351
|
+
* @id number The discount's Id
|
|
352
|
+
* @userIds number[] Filter UserIds Default All
|
|
353
|
+
* @email string Filter Email Default All
|
|
354
|
+
* @planIds number[] Filter PlanIds Default All
|
|
355
|
+
* @sortField string Sort Field,gmt_create|gmt_modify,Default gmt_modify
|
|
356
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
357
|
+
* @page number Page, Start 0
|
|
358
|
+
* @count number Count Of Per Page
|
|
359
|
+
* @createTimeStart number CreateTimeStart
|
|
360
|
+
* @createTimeEnd number CreateTimeEnd
|
|
361
|
+
*/
|
|
362
|
+
getDiscountUserDiscountList(params: {
|
|
363
|
+
id?: number;
|
|
364
|
+
userIds?: number[];
|
|
365
|
+
email?: string;
|
|
366
|
+
planIds?: number[];
|
|
367
|
+
sortField?: string;
|
|
368
|
+
sortType?: string;
|
|
369
|
+
page?: number;
|
|
370
|
+
count?: number;
|
|
371
|
+
createTimeStart?: number;
|
|
372
|
+
createTimeEnd?: number;
|
|
373
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
374
|
+
userDiscounts: DetailMerchantUserDiscountCodeDetail[];
|
|
375
|
+
total: number;
|
|
376
|
+
}>>;
|
|
377
|
+
/**
|
|
378
|
+
* Get Country Config List
|
|
379
|
+
* @schema ProfileEditCountryConfigReq
|
|
380
|
+
*/
|
|
381
|
+
editCountryConfig(body: ProfileEditCountryConfigReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
382
|
+
/**
|
|
383
|
+
* Get available EDM's for company'
|
|
384
|
+
* @mode string ul,fl
|
|
385
|
+
* @inn string INN, 2308266448
|
|
386
|
+
* @kpp string KPP, 230801001
|
|
387
|
+
*/
|
|
388
|
+
getEdmGetIdentity(params: {
|
|
389
|
+
mode?: string;
|
|
390
|
+
inn?: string;
|
|
391
|
+
kpp?: string;
|
|
392
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
393
|
+
data: SbisOrgData;
|
|
394
|
+
}>>;
|
|
395
|
+
/**
|
|
396
|
+
* EDM Gateway Setup
|
|
397
|
+
* @schema EdmSetupGatewayReq
|
|
398
|
+
*/
|
|
399
|
+
edmSetupGateway(body: EdmSetupGatewayReq): Promise<import("./types/shared").StdResponse<{
|
|
400
|
+
result: boolean;
|
|
401
|
+
}>>;
|
|
402
|
+
/**
|
|
403
|
+
* Customize Localization Template Sync
|
|
404
|
+
* @schema EmailCustomizeLocalizationTemplateSyncReq
|
|
405
|
+
*/
|
|
406
|
+
emailCustomLocalizationTemplateSync(body: EmailCustomizeLocalizationTemplateSyncReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
407
|
+
/**
|
|
408
|
+
* Email Sender Setup
|
|
409
|
+
* @schema EmailSenderSetupReq
|
|
410
|
+
*/
|
|
411
|
+
emailEmailSenderSetup(body: EmailSenderSetupReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
412
|
+
/**
|
|
413
|
+
* Email Gateway Setup
|
|
414
|
+
* @schema EmailGatewaySetupReq
|
|
415
|
+
*/
|
|
416
|
+
emailGatewaySetup(body: EmailGatewaySetupReq): Promise<import("./types/shared").StdResponse<{
|
|
417
|
+
data: string;
|
|
418
|
+
}>>;
|
|
419
|
+
/**
|
|
420
|
+
* Send Template Email To User
|
|
421
|
+
* @schema EmailSendTemplateEmailToUserReq
|
|
422
|
+
*/
|
|
423
|
+
emailSendTemplateEmailToUser(body: EmailSendTemplateEmailToUserReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
424
|
+
/**
|
|
425
|
+
* Email Template Activate
|
|
426
|
+
* @schema EmailTemplateActivateReq
|
|
427
|
+
*/
|
|
428
|
+
emailTemplateActivate(body: EmailTemplateActivateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
429
|
+
/**
|
|
430
|
+
* Email Template Deactivate
|
|
431
|
+
* @schema EmailTemplateDeactivateReq
|
|
432
|
+
*/
|
|
433
|
+
emailTemplateDeactivate(body: EmailTemplateDeactivateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
434
|
+
/**
|
|
435
|
+
* Get Email Template List
|
|
436
|
+
*/
|
|
437
|
+
getEmailTemplateList(): Promise<import("./types/shared").StdResponse<{
|
|
438
|
+
emailTemplateList: MerchantEmailTemplate[];
|
|
439
|
+
total: number;
|
|
440
|
+
}>>;
|
|
441
|
+
/**
|
|
442
|
+
* Setup Email Template Default
|
|
443
|
+
* @schema EmailTemplateSetDefaultReq
|
|
444
|
+
*/
|
|
445
|
+
emailTemplateSetDefault(body: EmailTemplateSetDefaultReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
446
|
+
/**
|
|
447
|
+
* Email Template Update
|
|
448
|
+
* @schema EmailTemplateUpdateReq
|
|
449
|
+
*/
|
|
450
|
+
emailTemplateUpdate(body: EmailTemplateUpdateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
451
|
+
/**
|
|
452
|
+
* Payment Gateway Archive
|
|
453
|
+
* @schema GatewayArchiveReq
|
|
454
|
+
*/
|
|
455
|
+
gatewayArchive(body: GatewayArchiveReq): Promise<import("./types/shared").StdResponse<{
|
|
456
|
+
gateway: DetailGateway;
|
|
457
|
+
}>>;
|
|
458
|
+
/**
|
|
459
|
+
* Payment Gateway
|
|
460
|
+
* @gatewayId number The id of payment gateway, either gatewayId or gatewayName
|
|
461
|
+
* @gatewayName string The name of payment gateway, , either gatewayId or gatewayName, stripe|paypal|changelly|unitpay|payssion|cryptadium
|
|
462
|
+
*/
|
|
463
|
+
getGatewayDetail(params: {
|
|
464
|
+
gatewayId?: number;
|
|
465
|
+
gatewayName?: string;
|
|
466
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
467
|
+
gateway: DetailGateway;
|
|
468
|
+
}>>;
|
|
469
|
+
/**
|
|
470
|
+
* Payment Gateway
|
|
471
|
+
* @schema GatewayDetailReq
|
|
472
|
+
*/
|
|
473
|
+
gatewayDetail(body: GatewayDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
474
|
+
gateway: DetailGateway;
|
|
475
|
+
}>>;
|
|
476
|
+
/**
|
|
477
|
+
* Payment Gateway Edit
|
|
478
|
+
* @schema GatewayEditReq
|
|
479
|
+
*/
|
|
480
|
+
gatewayEdit(body: GatewayEditReq): Promise<import("./types/shared").StdResponse<{
|
|
481
|
+
gateway: DetailGateway;
|
|
482
|
+
}>>;
|
|
483
|
+
/**
|
|
484
|
+
* Payment Gateway Country Config Edit
|
|
485
|
+
* @schema GatewayEditCountryConfigReq
|
|
486
|
+
*/
|
|
487
|
+
gatewayEditCountryConfig(body: GatewayEditCountryConfigReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
488
|
+
/**
|
|
489
|
+
* Edit Payment Gateway Sort
|
|
490
|
+
* @schema GatewayEditSortReq
|
|
491
|
+
*/
|
|
492
|
+
gatewayEditSort(body: GatewayEditSortReq): Promise<import("./types/shared").StdResponse<{
|
|
493
|
+
gateways: DetailGateway[];
|
|
494
|
+
}>>;
|
|
495
|
+
/**
|
|
496
|
+
* Get Payment Gateway List
|
|
497
|
+
* @archive boolean Filter archive gateway or not, default all
|
|
498
|
+
*/
|
|
499
|
+
getGatewayList(params: {
|
|
500
|
+
archive?: boolean;
|
|
501
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
502
|
+
gateways: DetailGateway[];
|
|
503
|
+
}>>;
|
|
504
|
+
/**
|
|
505
|
+
* Payment Gateway Setup
|
|
506
|
+
* @schema GatewaySetupReq
|
|
507
|
+
*/
|
|
508
|
+
gatewaySetup(body: GatewaySetupReq): Promise<import("./types/shared").StdResponse<{
|
|
509
|
+
gateway: DetailGateway;
|
|
510
|
+
}>>;
|
|
511
|
+
/**
|
|
512
|
+
* Exchange Rate Api Setup
|
|
513
|
+
* @schema GatewaySetupExchangeApiReq
|
|
514
|
+
*/
|
|
515
|
+
gatewaySetupExchangeRateApi(body: GatewaySetupExchangeApiReq): Promise<import("./types/shared").StdResponse<{
|
|
516
|
+
data: string;
|
|
517
|
+
}>>;
|
|
518
|
+
/**
|
|
519
|
+
* Get Payment Gateway Setup List
|
|
520
|
+
*/
|
|
521
|
+
getGatewaySetupList(): Promise<import("./types/shared").StdResponse<{
|
|
522
|
+
gateways: DetailGateway[];
|
|
523
|
+
}>>;
|
|
524
|
+
/**
|
|
525
|
+
* Payment Gateway Webhook Setup
|
|
526
|
+
* @schema GatewaySetupWebhookReq
|
|
527
|
+
*/
|
|
528
|
+
gatewaySetupWebhook(body: GatewaySetupWebhookReq): Promise<import("./types/shared").StdResponse<{
|
|
529
|
+
gatewayWebhookUrl: string;
|
|
530
|
+
}>>;
|
|
531
|
+
/**
|
|
532
|
+
* Wire Transfer Edit
|
|
533
|
+
* @schema GatewayWireTransferEditReq
|
|
534
|
+
*/
|
|
535
|
+
gatewayWireTransferEdit(body: GatewayWireTransferEditReq): Promise<import("./types/shared").StdResponse<{
|
|
536
|
+
gateway: DetailGateway;
|
|
537
|
+
}>>;
|
|
538
|
+
/**
|
|
539
|
+
* Wire Transfer Setup
|
|
540
|
+
* @schema GatewayWireTransferSetupReq
|
|
541
|
+
*/
|
|
542
|
+
gatewayWireTransferSetup(body: GatewayWireTransferSetupReq): Promise<import("./types/shared").StdResponse<{
|
|
543
|
+
gateway: DetailGateway;
|
|
544
|
+
}>>;
|
|
545
|
+
/**
|
|
546
|
+
* Get Profile
|
|
547
|
+
*/
|
|
548
|
+
get(): Promise<import("./types/shared").StdResponse<{
|
|
549
|
+
merchant: Merchant;
|
|
550
|
+
merchantMember: DetailMerchantMemberDetail;
|
|
551
|
+
env: string;
|
|
552
|
+
isProd: boolean;
|
|
553
|
+
TimeZone: string[];
|
|
554
|
+
Currency: Currency[];
|
|
555
|
+
gateways: DetailGateway[];
|
|
556
|
+
exchangeRateApiKey: string;
|
|
557
|
+
openApiKey: string;
|
|
558
|
+
sendGridKey: string;
|
|
559
|
+
vatSenseKey: string;
|
|
560
|
+
emailSender: Sender;
|
|
561
|
+
segmentServerSideKey: string;
|
|
562
|
+
segmentUserPortalKey: string;
|
|
563
|
+
isOwner: boolean;
|
|
564
|
+
MemberRoles: MerchantRole[];
|
|
565
|
+
}>>;
|
|
566
|
+
/**
|
|
567
|
+
* Admin Cancel Invoice
|
|
568
|
+
* @schema InvoiceCancelReq
|
|
569
|
+
*/
|
|
570
|
+
invoiceCancel(body: InvoiceCancelReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
571
|
+
/**
|
|
572
|
+
* Delete Pending Invoice
|
|
573
|
+
* @schema InvoiceDeleteReq
|
|
574
|
+
*/
|
|
575
|
+
invoiceDelete(body: InvoiceDeleteReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
576
|
+
/**
|
|
577
|
+
* Invoice Detail
|
|
578
|
+
* @invoiceId string The unique id of invoice
|
|
579
|
+
*/
|
|
580
|
+
getInvoiceDetail(params: {
|
|
581
|
+
invoiceId?: string;
|
|
582
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
583
|
+
invoice: DetailInvoiceDetail;
|
|
584
|
+
creditNotes: DetailInvoiceDetail[];
|
|
585
|
+
}>>;
|
|
586
|
+
/**
|
|
587
|
+
* Invoice Detail
|
|
588
|
+
* @schema InvoiceDetailReq
|
|
589
|
+
*/
|
|
590
|
+
invoiceDetail(body: InvoiceDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
591
|
+
invoice: DetailInvoiceDetail;
|
|
592
|
+
creditNotes: DetailInvoiceDetail[];
|
|
593
|
+
}>>;
|
|
594
|
+
/**
|
|
595
|
+
* Invoice Edit
|
|
596
|
+
* @schema InvoiceEditReq
|
|
597
|
+
*/
|
|
598
|
+
invoiceEdit(body: InvoiceEditReq): Promise<import("./types/shared").StdResponse<{
|
|
599
|
+
invoice: DetailInvoiceDetail;
|
|
600
|
+
}>>;
|
|
601
|
+
/**
|
|
602
|
+
* Finish Invoice
|
|
603
|
+
* @schema InvoiceFinishReq
|
|
604
|
+
*/
|
|
605
|
+
invoiceFinish(body: InvoiceFinishReq): Promise<import("./types/shared").StdResponse<{
|
|
606
|
+
invoice: Invoice;
|
|
607
|
+
}>>;
|
|
608
|
+
/**
|
|
609
|
+
* Get Invoice List
|
|
610
|
+
* @firstName string The firstName of invoice
|
|
611
|
+
* @lastName string The lastName of invoice
|
|
612
|
+
* @currency string The currency of invoice
|
|
613
|
+
* @status number[] The status of invoice, 1-pending|2-processing|3-paid | 4-failed | 5-cancelled
|
|
614
|
+
* @amountStart number The filter start amount of invoice
|
|
615
|
+
* @amountEnd number The filter end amount of invoice
|
|
616
|
+
* @userId number The filter userid of invoice
|
|
617
|
+
* @sendEmail string The filter email of invoice
|
|
618
|
+
* @sortField string Filter,em. invoice_id|gmt_create|gmt_modify|period_end|total_amount,Default gmt_modify
|
|
619
|
+
* @sortType string Sort,asc|desc,Default desc
|
|
620
|
+
* @deleteInclude boolean Deleted Involved,Need Admin Permission
|
|
621
|
+
* @type number invoice Type, 0-payment, 1-refund
|
|
622
|
+
* @page number Page, Start 0
|
|
623
|
+
* @count number Count By Page
|
|
624
|
+
* @createTimeStart number CreateTimeStart
|
|
625
|
+
* @createTimeEnd number CreateTimeEnd
|
|
626
|
+
* @reportTimeStart number ReportTimeStart
|
|
627
|
+
* @reportTimeEnd number ReportTimeEnd
|
|
628
|
+
*/
|
|
629
|
+
getInvoiceList(params: {
|
|
630
|
+
firstName?: string;
|
|
631
|
+
lastName?: string;
|
|
632
|
+
currency?: string;
|
|
633
|
+
status?: number[];
|
|
634
|
+
amountStart?: number;
|
|
635
|
+
amountEnd?: number;
|
|
636
|
+
userId?: number;
|
|
637
|
+
sendEmail?: string;
|
|
638
|
+
sortField?: string;
|
|
639
|
+
sortType?: string;
|
|
640
|
+
deleteInclude?: boolean;
|
|
641
|
+
type?: number;
|
|
642
|
+
page?: number;
|
|
643
|
+
count?: number;
|
|
644
|
+
createTimeStart?: number;
|
|
645
|
+
createTimeEnd?: number;
|
|
646
|
+
reportTimeStart?: number;
|
|
647
|
+
reportTimeEnd?: number;
|
|
648
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
649
|
+
invoices: DetailInvoiceDetail[];
|
|
650
|
+
total: number;
|
|
651
|
+
}>>;
|
|
652
|
+
/**
|
|
653
|
+
* Get Invoice List
|
|
654
|
+
* @schema InvoiceListReq
|
|
655
|
+
*/
|
|
656
|
+
invoiceList(body: InvoiceListReq): Promise<import("./types/shared").StdResponse<{
|
|
657
|
+
invoices: DetailInvoiceDetail[];
|
|
658
|
+
total: number;
|
|
659
|
+
}>>;
|
|
660
|
+
/**
|
|
661
|
+
* Mark Invoice Refund
|
|
662
|
+
* @schema InvoiceMarkRefundReq
|
|
663
|
+
*/
|
|
664
|
+
invoiceMarkRefund(body: InvoiceMarkRefundReq): Promise<import("./types/shared").StdResponse<{
|
|
665
|
+
refund: Refund;
|
|
666
|
+
}>>;
|
|
667
|
+
/**
|
|
668
|
+
* Mark Invoice Refund As Success
|
|
669
|
+
* @schema InvoiceMarkRefundInvoiceSuccessReq
|
|
670
|
+
*/
|
|
671
|
+
invoiceMarkRefundSuccess(body: InvoiceMarkRefundInvoiceSuccessReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
672
|
+
/**
|
|
673
|
+
* Mark Wire Transfer Invoice As Success
|
|
674
|
+
* @schema InvoiceMarkWireTransferSuccessReq
|
|
675
|
+
*/
|
|
676
|
+
invoiceMarkWireTransferSuccess(body: InvoiceMarkWireTransferSuccessReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
677
|
+
/**
|
|
678
|
+
* New Invoice
|
|
679
|
+
* @schema InvoiceNewReq
|
|
680
|
+
*/
|
|
681
|
+
invoiceNew(body: InvoiceNewReq): Promise<import("./types/shared").StdResponse<{
|
|
682
|
+
invoice: DetailInvoiceDetail;
|
|
683
|
+
}>>;
|
|
684
|
+
/**
|
|
685
|
+
* Generate Invoice PDF
|
|
686
|
+
* @schema InvoicePdfGenerateReq
|
|
687
|
+
*/
|
|
688
|
+
invoicePdfGenerate(body: InvoicePdfGenerateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
689
|
+
/**
|
|
690
|
+
* Update Invoice PDF
|
|
691
|
+
* @schema InvoicePdfUpdateReq
|
|
692
|
+
*/
|
|
693
|
+
invoicePdfUpdate(body: InvoicePdfUpdateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
694
|
+
/**
|
|
695
|
+
* Admin Reconvert Crypto Data and Send Invoice Email
|
|
696
|
+
* @schema InvoiceReconvertCryptoAndSendReq
|
|
697
|
+
*/
|
|
698
|
+
invoiceReconvertCryptoAndSendEmail(body: InvoiceReconvertCryptoAndSendReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
699
|
+
/**
|
|
700
|
+
* Create InvoiceRefund
|
|
701
|
+
* @schema InvoiceRefundReq
|
|
702
|
+
*/
|
|
703
|
+
invoiceRefund(body: InvoiceRefundReq): Promise<import("./types/shared").StdResponse<{
|
|
704
|
+
refund: Refund;
|
|
705
|
+
}>>;
|
|
706
|
+
/**
|
|
707
|
+
* Send Invoice Email
|
|
708
|
+
* @schema InvoiceSendEmailReq
|
|
709
|
+
*/
|
|
710
|
+
invoiceSendEmail(body: InvoiceSendEmailReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
711
|
+
/**
|
|
712
|
+
* Get Member List
|
|
713
|
+
* @roleIds number[] The member roleId if specified'
|
|
714
|
+
* @page number Page, Start With 0
|
|
715
|
+
* @count number Count Of Page
|
|
716
|
+
*/
|
|
717
|
+
getMemberList(params: {
|
|
718
|
+
roleIds?: number[];
|
|
719
|
+
page?: number;
|
|
720
|
+
count?: number;
|
|
721
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
722
|
+
merchantMembers: DetailMerchantMemberDetail[];
|
|
723
|
+
total: number;
|
|
724
|
+
}>>;
|
|
725
|
+
/**
|
|
726
|
+
* Get Member List
|
|
727
|
+
* @schema MemberListReq
|
|
728
|
+
*/
|
|
729
|
+
memberList(body: MemberListReq): Promise<import("./types/shared").StdResponse<{
|
|
730
|
+
merchantMembers: DetailMerchantMemberDetail[];
|
|
731
|
+
total: number;
|
|
732
|
+
}>>;
|
|
733
|
+
/**
|
|
734
|
+
* Logout
|
|
735
|
+
* @schema MemberLogoutReq
|
|
736
|
+
*/
|
|
737
|
+
memberLogout(body: MemberLogoutReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
738
|
+
/**
|
|
739
|
+
* Invite member
|
|
740
|
+
* @schema MemberNewMemberReq
|
|
741
|
+
*/
|
|
742
|
+
memberNewMember(body: MemberNewMemberReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
743
|
+
/**
|
|
744
|
+
* Get Member Operation Log List
|
|
745
|
+
* @memberFirstName string Filter Member's FirstName Default All
|
|
746
|
+
* @memberLastName string Filter Member's LastName, Default All
|
|
747
|
+
* @memberEmail string Filter Member's Email, Default All
|
|
748
|
+
* @firstName string FirstName
|
|
749
|
+
* @lastName string LastName
|
|
750
|
+
* @email string Email
|
|
751
|
+
* @subscriptionId string subscription_id
|
|
752
|
+
* @invoiceId string invoice id
|
|
753
|
+
* @planId number plan id
|
|
754
|
+
* @discountCode string discount_code
|
|
755
|
+
* @page number Page, Start With 0
|
|
756
|
+
* @count number Count Of Page
|
|
757
|
+
*/
|
|
758
|
+
getMemberOperationLogList(params: {
|
|
759
|
+
memberFirstName?: string;
|
|
760
|
+
memberLastName?: string;
|
|
761
|
+
memberEmail?: string;
|
|
762
|
+
firstName?: string;
|
|
763
|
+
lastName?: string;
|
|
764
|
+
email?: string;
|
|
765
|
+
subscriptionId?: string;
|
|
766
|
+
invoiceId?: string;
|
|
767
|
+
planId?: number;
|
|
768
|
+
discountCode?: string;
|
|
769
|
+
page?: number;
|
|
770
|
+
count?: number;
|
|
771
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
772
|
+
merchantOperationLogs: DetailMerchantOperationLogDetail[];
|
|
773
|
+
total: number;
|
|
774
|
+
}>>;
|
|
775
|
+
/**
|
|
776
|
+
* Member Reset Password
|
|
777
|
+
* @schema MemberPasswordResetReq
|
|
778
|
+
*/
|
|
779
|
+
memberPasswordReset(body: MemberPasswordResetReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
780
|
+
/**
|
|
781
|
+
* Get Member Profile
|
|
782
|
+
*/
|
|
783
|
+
getMemberProfile(): Promise<import("./types/shared").StdResponse<{
|
|
784
|
+
merchantMember: DetailMerchantMemberDetail;
|
|
785
|
+
}>>;
|
|
786
|
+
/**
|
|
787
|
+
* Resume Member
|
|
788
|
+
* @schema MemberReleaseReq
|
|
789
|
+
*/
|
|
790
|
+
memberResumeMember(body: MemberReleaseReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
791
|
+
/**
|
|
792
|
+
* Suspend Member
|
|
793
|
+
* @schema MemberFrozenReq
|
|
794
|
+
*/
|
|
795
|
+
memberSuspendMember(body: MemberFrozenReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
796
|
+
/**
|
|
797
|
+
* Update Member Profile
|
|
798
|
+
* @schema MemberUpdateReq
|
|
799
|
+
*/
|
|
800
|
+
memberUpdate(body: MemberUpdateReq): Promise<import("./types/shared").StdResponse<{
|
|
801
|
+
merchantMember: DetailMerchantMemberDetail;
|
|
802
|
+
}>>;
|
|
803
|
+
/**
|
|
804
|
+
* Update Member Role
|
|
805
|
+
* @schema MemberUpdateMemberRoleReq
|
|
806
|
+
*/
|
|
807
|
+
memberUpdateMemberRole(body: MemberUpdateMemberRoleReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
808
|
+
/**
|
|
809
|
+
* Delete Merchant Metric
|
|
810
|
+
* @schema MetricDeleteReq
|
|
811
|
+
*/
|
|
812
|
+
metricDelete(body: MetricDeleteReq): Promise<import("./types/shared").StdResponse<{
|
|
813
|
+
merchantMetric: MerchantMetric;
|
|
814
|
+
}>>;
|
|
815
|
+
/**
|
|
816
|
+
* Merchant Metric Detail
|
|
817
|
+
* @schema MetricDetailReq
|
|
818
|
+
*/
|
|
819
|
+
metricDetail(body: MetricDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
820
|
+
merchantMetric: MerchantMetric;
|
|
821
|
+
}>>;
|
|
822
|
+
/**
|
|
823
|
+
* Edit Merchant Metric
|
|
824
|
+
* @schema MetricEditReq
|
|
825
|
+
*/
|
|
826
|
+
metricEdit(body: MetricEditReq): Promise<import("./types/shared").StdResponse<{
|
|
827
|
+
merchantMetric: MerchantMetric;
|
|
828
|
+
}>>;
|
|
829
|
+
/**
|
|
830
|
+
* Del Merchant Metric Event
|
|
831
|
+
* @schema MetricDeleteEventReq
|
|
832
|
+
*/
|
|
833
|
+
metricEventDelete(body: MetricDeleteEventReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
834
|
+
/**
|
|
835
|
+
* New Merchant Metric Event
|
|
836
|
+
* @schema MetricNewEventReq
|
|
837
|
+
*/
|
|
838
|
+
metricEventNew(body: MetricNewEventReq): Promise<import("./types/shared").StdResponse<{
|
|
839
|
+
merchantMetricEvent: MerchantMetricEvent;
|
|
840
|
+
}>>;
|
|
841
|
+
/**
|
|
842
|
+
* Metric Event List
|
|
843
|
+
* @userIds number[] Filter UserIds, Default All
|
|
844
|
+
* @metricIds number[] Filter MetricIds, Default All
|
|
845
|
+
* @sortField string Sort,user_id|gmt_create,Default gmt_create
|
|
846
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
847
|
+
* @page number Page,Start 0
|
|
848
|
+
* @count number Count OF Page
|
|
849
|
+
* @createTimeStart number CreateTimeStart
|
|
850
|
+
* @createTimeEnd number CreateTimeEnd
|
|
851
|
+
*/
|
|
852
|
+
getMetricEventList(params: {
|
|
853
|
+
userIds?: number[];
|
|
854
|
+
metricIds?: number[];
|
|
855
|
+
sortField?: string;
|
|
856
|
+
sortType?: string;
|
|
857
|
+
page?: number;
|
|
858
|
+
count?: number;
|
|
859
|
+
createTimeStart?: number;
|
|
860
|
+
createTimeEnd?: number;
|
|
861
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
862
|
+
events: DetailMerchantMetricEventDetail[];
|
|
863
|
+
total: number;
|
|
864
|
+
}>>;
|
|
865
|
+
/**
|
|
866
|
+
* Metric Event List
|
|
867
|
+
* @schema MetricEventListReq
|
|
868
|
+
*/
|
|
869
|
+
metricEventList(body: MetricEventListReq): Promise<import("./types/shared").StdResponse<{
|
|
870
|
+
events: DetailMerchantMetricEventDetail[];
|
|
871
|
+
total: number;
|
|
872
|
+
}>>;
|
|
873
|
+
/**
|
|
874
|
+
* Get Merchant Metric list
|
|
875
|
+
* @sortField string Sort,user_id|gmt_create,Default gmt_create
|
|
876
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
877
|
+
* @page number Page,Start 0
|
|
878
|
+
* @count number Count OF Page
|
|
879
|
+
* @createTimeStart number CreateTimeStart
|
|
880
|
+
* @createTimeEnd number CreateTimeEnd
|
|
881
|
+
*/
|
|
882
|
+
getMetricList(params: {
|
|
883
|
+
sortField?: string;
|
|
884
|
+
sortType?: string;
|
|
885
|
+
page?: number;
|
|
886
|
+
count?: number;
|
|
887
|
+
createTimeStart?: number;
|
|
888
|
+
createTimeEnd?: number;
|
|
889
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
890
|
+
merchantMetrics: MerchantMetric[];
|
|
891
|
+
total: number;
|
|
892
|
+
}>>;
|
|
893
|
+
/**
|
|
894
|
+
* Get Merchant Metric list
|
|
895
|
+
* @schema MetricListReq
|
|
896
|
+
*/
|
|
897
|
+
metricList(body: MetricListReq): Promise<import("./types/shared").StdResponse<{
|
|
898
|
+
merchantMetrics: MerchantMetric[];
|
|
899
|
+
total: number;
|
|
900
|
+
}>>;
|
|
901
|
+
/**
|
|
902
|
+
* New Merchant Metric
|
|
903
|
+
* @schema MetricNewReq
|
|
904
|
+
*/
|
|
905
|
+
metricNew(body: MetricNewReq): Promise<import("./types/shared").StdResponse<{
|
|
906
|
+
merchantMetric: MerchantMetric;
|
|
907
|
+
}>>;
|
|
908
|
+
/**
|
|
909
|
+
* Delete Merchant Metric Plan TotalLimit
|
|
910
|
+
* @schema MetricDeletePlanLimitReq
|
|
911
|
+
*/
|
|
912
|
+
metricPlanLimitDelete(body: MetricDeletePlanLimitReq): Promise<import("./types/shared").StdResponse<{
|
|
913
|
+
merchantMetricPlanLimit: DetailMerchantMetricPlanLimitDetail;
|
|
914
|
+
}>>;
|
|
915
|
+
/**
|
|
916
|
+
* Edit Merchant Metric Plan TotalLimit
|
|
917
|
+
* @schema MetricEditPlanLimitReq
|
|
918
|
+
*/
|
|
919
|
+
metricPlanLimitEdit(body: MetricEditPlanLimitReq): Promise<import("./types/shared").StdResponse<{
|
|
920
|
+
merchantMetricPlanLimit: DetailMerchantMetricPlanLimitDetail;
|
|
921
|
+
}>>;
|
|
922
|
+
/**
|
|
923
|
+
* New Merchant Metric Plan TotalLimit
|
|
924
|
+
* @schema MetricNewPlanLimitReq
|
|
925
|
+
*/
|
|
926
|
+
metricPlanLimitNew(body: MetricNewPlanLimitReq): Promise<import("./types/shared").StdResponse<{
|
|
927
|
+
merchantMetricPlanLimit: DetailMerchantMetricPlanLimitDetail;
|
|
928
|
+
}>>;
|
|
929
|
+
/**
|
|
930
|
+
* Query User Metric
|
|
931
|
+
* @userId number UserId, One Of UserId|ExternalUserId Needed
|
|
932
|
+
* @externalUserId string ExternalUserId, One Of UserId|ExternalUserId Needed
|
|
933
|
+
* @productId number default product will use if productId not specified and subscriptionId is blank
|
|
934
|
+
*/
|
|
935
|
+
getMetricUserMetric(params: {
|
|
936
|
+
userId?: number;
|
|
937
|
+
externalUserId?: string;
|
|
938
|
+
productId?: number;
|
|
939
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
940
|
+
userMetric: DetailUserMetric;
|
|
941
|
+
}>>;
|
|
942
|
+
/**
|
|
943
|
+
* Query User Metric By Subscription
|
|
944
|
+
* @subscriptionId string SubscriptionId
|
|
945
|
+
*/
|
|
946
|
+
getMetricUserSubMetric(params: {
|
|
947
|
+
subscriptionId?: string;
|
|
948
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
949
|
+
userMetric: DetailUserMetric;
|
|
950
|
+
}>>;
|
|
951
|
+
/**
|
|
952
|
+
* Generate New APIKey
|
|
953
|
+
* @schema ProfileNewApiKeyReq
|
|
954
|
+
*/
|
|
955
|
+
newApikey(body: ProfileNewApiKeyReq): Promise<import("./types/shared").StdResponse<{
|
|
956
|
+
apiKey: string;
|
|
957
|
+
}>>;
|
|
958
|
+
/**
|
|
959
|
+
* Upload File
|
|
960
|
+
*/
|
|
961
|
+
ossFile(): Promise<import("./types/shared").StdResponse<{
|
|
962
|
+
url: string;
|
|
963
|
+
}>>;
|
|
964
|
+
/**
|
|
965
|
+
* Cancel Payment
|
|
966
|
+
* @schema PaymentCancelReq
|
|
967
|
+
*/
|
|
968
|
+
paymentCancel(body: PaymentCancelReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
969
|
+
/**
|
|
970
|
+
* Capture Payment
|
|
971
|
+
* @schema PaymentCaptureReq
|
|
972
|
+
*/
|
|
973
|
+
paymentCapture(body: PaymentCaptureReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
974
|
+
/**
|
|
975
|
+
* Payment Detail
|
|
976
|
+
* @paymentId string The unique id of payment
|
|
977
|
+
*/
|
|
978
|
+
getPaymentDetail(params: {
|
|
979
|
+
paymentId?: string;
|
|
980
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
981
|
+
paymentDetail: DetailPaymentDetail;
|
|
982
|
+
}>>;
|
|
983
|
+
/**
|
|
984
|
+
* Get OneTime Payment Item List
|
|
985
|
+
* @userId number Filter UserId, Default All
|
|
986
|
+
* @sortField string Sort,invoice_id|gmt_create|gmt_modify|period_end|total_amount,Default gmt_modify
|
|
987
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
988
|
+
* @page number Page,Start 0
|
|
989
|
+
* @count number Count Of Page
|
|
990
|
+
*/
|
|
991
|
+
getPaymentItemList(params: {
|
|
992
|
+
userId?: number;
|
|
993
|
+
sortField?: string;
|
|
994
|
+
sortType?: string;
|
|
995
|
+
page?: number;
|
|
996
|
+
count?: number;
|
|
997
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
998
|
+
paymentItems: PaymentItem[];
|
|
999
|
+
total: number;
|
|
1000
|
+
}>>;
|
|
1001
|
+
/**
|
|
1002
|
+
* Get Payment List
|
|
1003
|
+
* @gatewayId number The filter unique id of gateway
|
|
1004
|
+
* @userId number The filter userid of payment
|
|
1005
|
+
* @email string The filter email of payment
|
|
1006
|
+
* @status number The filter status of payment, 10-Created|20-Success|30-Failed|40-Cancelled
|
|
1007
|
+
* @currency string The filter currency of payment
|
|
1008
|
+
* @countryCode string The filter country code of payment
|
|
1009
|
+
* @sortField string Sort Field,user_id|create_time|status
|
|
1010
|
+
* @sortType string Sort Type,asc|desc
|
|
1011
|
+
* @page number Page, Start With 0
|
|
1012
|
+
* @count number Count Of Page
|
|
1013
|
+
*/
|
|
1014
|
+
getPaymentList(params: {
|
|
1015
|
+
gatewayId?: number;
|
|
1016
|
+
userId?: number;
|
|
1017
|
+
email?: string;
|
|
1018
|
+
status?: number;
|
|
1019
|
+
currency?: string;
|
|
1020
|
+
countryCode?: string;
|
|
1021
|
+
sortField?: string;
|
|
1022
|
+
sortType?: string;
|
|
1023
|
+
page?: number;
|
|
1024
|
+
count?: number;
|
|
1025
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1026
|
+
paymentDetails: DetailPaymentDetail[];
|
|
1027
|
+
total: number;
|
|
1028
|
+
}>>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Delete Payment Method
|
|
1031
|
+
* @schema PaymentMethodDeleteReq
|
|
1032
|
+
*/
|
|
1033
|
+
paymentMethodDelete(body: PaymentMethodDeleteReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1034
|
+
/**
|
|
1035
|
+
* Payment Method
|
|
1036
|
+
* @gatewayId number The unique id of gateway
|
|
1037
|
+
* @userId number The customer's unique id
|
|
1038
|
+
* @paymentMethodId string The unique id of payment method
|
|
1039
|
+
*/
|
|
1040
|
+
getPaymentMethodGet(params: {
|
|
1041
|
+
gatewayId?: number;
|
|
1042
|
+
userId?: number;
|
|
1043
|
+
paymentMethodId?: string;
|
|
1044
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1045
|
+
method: PaymentMethod;
|
|
1046
|
+
}>>;
|
|
1047
|
+
/**
|
|
1048
|
+
* Payment Method List
|
|
1049
|
+
* @gatewayId number The unique id of gateway
|
|
1050
|
+
* @userId number The id of user
|
|
1051
|
+
* @paymentId string The unique id of payment
|
|
1052
|
+
*/
|
|
1053
|
+
getPaymentMethodList(params: {
|
|
1054
|
+
gatewayId?: number;
|
|
1055
|
+
userId?: number;
|
|
1056
|
+
paymentId?: string;
|
|
1057
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1058
|
+
methodList: PaymentMethod[];
|
|
1059
|
+
}>>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Create New Payment Method
|
|
1062
|
+
* @schema PaymentMethodNewReq
|
|
1063
|
+
*/
|
|
1064
|
+
paymentMethodNew(body: PaymentMethodNewReq): Promise<import("./types/shared").StdResponse<{
|
|
1065
|
+
url: string;
|
|
1066
|
+
method: PaymentMethod;
|
|
1067
|
+
}>>;
|
|
1068
|
+
/**
|
|
1069
|
+
* New Payment
|
|
1070
|
+
* @schema PaymentNewReq
|
|
1071
|
+
*/
|
|
1072
|
+
paymentNew(body: PaymentNewReq): Promise<import("./types/shared").StdResponse<{
|
|
1073
|
+
status: number;
|
|
1074
|
+
paymentId: string;
|
|
1075
|
+
externalPaymentId: string;
|
|
1076
|
+
link: string;
|
|
1077
|
+
action: any;
|
|
1078
|
+
}>>;
|
|
1079
|
+
/**
|
|
1080
|
+
* Cancel Payment Refund
|
|
1081
|
+
* @schema PaymentRefundCancelReq
|
|
1082
|
+
*/
|
|
1083
|
+
paymentRefundCancel(body: PaymentRefundCancelReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1084
|
+
/**
|
|
1085
|
+
* Payment Refund Detail
|
|
1086
|
+
* @refundId string RefundId
|
|
1087
|
+
*/
|
|
1088
|
+
getPaymentRefundDetail(params: {
|
|
1089
|
+
refundId?: string;
|
|
1090
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1091
|
+
refundDetail: DetailRefundDetail;
|
|
1092
|
+
}>>;
|
|
1093
|
+
/**
|
|
1094
|
+
* Get Payment Refund List
|
|
1095
|
+
* @paymentId string PaymentId
|
|
1096
|
+
* @status number Status,10-create|20-success|30-Failed|40-Reverse
|
|
1097
|
+
* @gatewayId number GatewayId
|
|
1098
|
+
* @userId number UserId
|
|
1099
|
+
* @email string Email
|
|
1100
|
+
* @currency string Currency
|
|
1101
|
+
*/
|
|
1102
|
+
getPaymentRefundList(params: {
|
|
1103
|
+
paymentId?: string;
|
|
1104
|
+
status?: number;
|
|
1105
|
+
gatewayId?: number;
|
|
1106
|
+
userId?: number;
|
|
1107
|
+
email?: string;
|
|
1108
|
+
currency?: string;
|
|
1109
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1110
|
+
refundDetails: DetailRefundDetail[];
|
|
1111
|
+
total: number;
|
|
1112
|
+
}>>;
|
|
1113
|
+
/**
|
|
1114
|
+
* New Payment Refund
|
|
1115
|
+
* @schema PaymentNewPaymentRefundReq
|
|
1116
|
+
*/
|
|
1117
|
+
paymentRefundNew(body: PaymentNewPaymentRefundReq): Promise<import("./types/shared").StdResponse<{
|
|
1118
|
+
status: number;
|
|
1119
|
+
refundId: string;
|
|
1120
|
+
externalRefundId: string;
|
|
1121
|
+
paymentId: string;
|
|
1122
|
+
}>>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Get Payment TimeLine List
|
|
1125
|
+
* @userId number Filter UserId, Default All
|
|
1126
|
+
* @amountStart number The filter start amount of timeline
|
|
1127
|
+
* @amountEnd number The filter end amount of timeline
|
|
1128
|
+
* @status number[] The filter status, 0-pending, 1-success, 2-failure,3-cancel
|
|
1129
|
+
* @timelineTypes number[] The filter timelineType, 0-pay, 1-refund
|
|
1130
|
+
* @gatewayIds number[] The filter ids of gateway
|
|
1131
|
+
* @currency string Currency
|
|
1132
|
+
* @sortField string Sort,invoice_id|gmt_create|gmt_modify|period_end|total_amount,Default gmt_modify
|
|
1133
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
1134
|
+
* @page number Page,Start 0
|
|
1135
|
+
* @count number Count Of Page
|
|
1136
|
+
* @createTimeStart number CreateTimeStart
|
|
1137
|
+
* @createTimeEnd number CreateTimeEnd
|
|
1138
|
+
*/
|
|
1139
|
+
getPaymentTimelineList(params: {
|
|
1140
|
+
userId?: number;
|
|
1141
|
+
amountStart?: number;
|
|
1142
|
+
amountEnd?: number;
|
|
1143
|
+
status?: number[];
|
|
1144
|
+
timelineTypes?: number[];
|
|
1145
|
+
gatewayIds?: number[];
|
|
1146
|
+
currency?: string;
|
|
1147
|
+
sortField?: string;
|
|
1148
|
+
sortType?: string;
|
|
1149
|
+
page?: number;
|
|
1150
|
+
count?: number;
|
|
1151
|
+
createTimeStart?: number;
|
|
1152
|
+
createTimeEnd?: number;
|
|
1153
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1154
|
+
paymentTimeLines: DetailPaymentTimelineDetail[];
|
|
1155
|
+
total: number;
|
|
1156
|
+
}>>;
|
|
1157
|
+
/**
|
|
1158
|
+
* Get Payment TimeLine List
|
|
1159
|
+
* @schema PaymentTimeLineListReq
|
|
1160
|
+
*/
|
|
1161
|
+
paymentTimelineList(body: PaymentTimeLineListReq): Promise<import("./types/shared").StdResponse<{
|
|
1162
|
+
paymentTimeLines: DetailPaymentTimelineDetail[];
|
|
1163
|
+
total: number;
|
|
1164
|
+
}>>;
|
|
1165
|
+
/**
|
|
1166
|
+
* Activate Plan
|
|
1167
|
+
* @schema PlanActivateReq
|
|
1168
|
+
*/
|
|
1169
|
+
planActivate(body: PlanActivateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1170
|
+
/**
|
|
1171
|
+
* Addon Binding
|
|
1172
|
+
* @schema PlanAddonsBindingReq
|
|
1173
|
+
*/
|
|
1174
|
+
planAddonsBinding(body: PlanAddonsBindingReq): Promise<import("./types/shared").StdResponse<{
|
|
1175
|
+
plan: Plan;
|
|
1176
|
+
}>>;
|
|
1177
|
+
/**
|
|
1178
|
+
* Archive Plan
|
|
1179
|
+
* @schema PlanArchiveReq
|
|
1180
|
+
*/
|
|
1181
|
+
planArchive(body: PlanArchiveReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1182
|
+
/**
|
|
1183
|
+
* Copy Plan
|
|
1184
|
+
* @schema PlanCopyReq
|
|
1185
|
+
*/
|
|
1186
|
+
planCopy(body: PlanCopyReq): Promise<import("./types/shared").StdResponse<{
|
|
1187
|
+
plan: Plan;
|
|
1188
|
+
}>>;
|
|
1189
|
+
/**
|
|
1190
|
+
* Delete Plan
|
|
1191
|
+
* @schema PlanDeleteReq
|
|
1192
|
+
*/
|
|
1193
|
+
planDelete(body: PlanDeleteReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1194
|
+
/**
|
|
1195
|
+
* Plan Detail
|
|
1196
|
+
* @planId number PlanId
|
|
1197
|
+
*/
|
|
1198
|
+
getPlanDetail(params: {
|
|
1199
|
+
planId?: number;
|
|
1200
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1201
|
+
plan: DetailPlanDetail;
|
|
1202
|
+
}>>;
|
|
1203
|
+
/**
|
|
1204
|
+
* Plan Detail
|
|
1205
|
+
* @schema PlanDetailReq
|
|
1206
|
+
*/
|
|
1207
|
+
planDetail(body: PlanDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
1208
|
+
plan: DetailPlanDetail;
|
|
1209
|
+
}>>;
|
|
1210
|
+
/**
|
|
1211
|
+
* Edit Plan
|
|
1212
|
+
* @schema PlanEditReq
|
|
1213
|
+
*/
|
|
1214
|
+
planEdit(body: PlanEditReq): Promise<import("./types/shared").StdResponse<{
|
|
1215
|
+
plan: Plan;
|
|
1216
|
+
}>>;
|
|
1217
|
+
/**
|
|
1218
|
+
* Get Plan List
|
|
1219
|
+
* @productIds number[] filter id list of product, default all
|
|
1220
|
+
* @type number[] 1-main plan,2-addon plan
|
|
1221
|
+
* @status number[] Filter, Default All,,Status,1-Editing,2-Active,3-InActive,4-SoftArchive, 5-HardArchive
|
|
1222
|
+
* @publishStatus number Filter, Default All,PublishStatus,1-UnPublished,2-Published
|
|
1223
|
+
* @currency string Filter Currency
|
|
1224
|
+
* @searchKey string Search Key, plan name or description
|
|
1225
|
+
* @sortField string Sort Field,plan_name|gmt_create|gmt_modify,Default gmt_create
|
|
1226
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
1227
|
+
* @page number Page, Start 0
|
|
1228
|
+
* @count number Count Of Per Page
|
|
1229
|
+
*/
|
|
1230
|
+
getPlanList(params: {
|
|
1231
|
+
productIds?: number[];
|
|
1232
|
+
type?: number[];
|
|
1233
|
+
status?: number[];
|
|
1234
|
+
publishStatus?: number;
|
|
1235
|
+
currency?: string;
|
|
1236
|
+
searchKey?: string;
|
|
1237
|
+
sortField?: string;
|
|
1238
|
+
sortType?: string;
|
|
1239
|
+
page?: number;
|
|
1240
|
+
count?: number;
|
|
1241
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1242
|
+
plans: DetailPlanDetail[];
|
|
1243
|
+
total: number;
|
|
1244
|
+
}>>;
|
|
1245
|
+
/**
|
|
1246
|
+
* Get Plan List
|
|
1247
|
+
* @schema PlanListReq
|
|
1248
|
+
*/
|
|
1249
|
+
planList(body: PlanListReq): Promise<import("./types/shared").StdResponse<{
|
|
1250
|
+
plans: DetailPlanDetail[];
|
|
1251
|
+
total: number;
|
|
1252
|
+
}>>;
|
|
1253
|
+
/**
|
|
1254
|
+
* Create Plan
|
|
1255
|
+
* @schema PlanNewReq
|
|
1256
|
+
*/
|
|
1257
|
+
planNew(body: PlanNewReq): Promise<import("./types/shared").StdResponse<{
|
|
1258
|
+
plan: Plan;
|
|
1259
|
+
}>>;
|
|
1260
|
+
/**
|
|
1261
|
+
* Publish Plan
|
|
1262
|
+
* @schema PlanPublishReq
|
|
1263
|
+
*/
|
|
1264
|
+
planPublish(body: PlanPublishReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1265
|
+
/**
|
|
1266
|
+
* UnPublish Plan
|
|
1267
|
+
* @schema PlanUnPublishReq
|
|
1268
|
+
*/
|
|
1269
|
+
planUnpublished(body: PlanUnPublishReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1270
|
+
/**
|
|
1271
|
+
* Activate Product
|
|
1272
|
+
* @schema ProductActivateReq
|
|
1273
|
+
*/
|
|
1274
|
+
productActivate(body: ProductActivateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1275
|
+
/**
|
|
1276
|
+
* Copy Product
|
|
1277
|
+
* @schema ProductCopyReq
|
|
1278
|
+
*/
|
|
1279
|
+
productCopy(body: ProductCopyReq): Promise<import("./types/shared").StdResponse<{
|
|
1280
|
+
product: Product;
|
|
1281
|
+
}>>;
|
|
1282
|
+
/**
|
|
1283
|
+
* Delete Product
|
|
1284
|
+
* @schema ProductDeleteReq
|
|
1285
|
+
*/
|
|
1286
|
+
productDelete(body: ProductDeleteReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1287
|
+
/**
|
|
1288
|
+
* Product Detail
|
|
1289
|
+
* @productId number ProductId
|
|
1290
|
+
*/
|
|
1291
|
+
getProductDetail(params: {
|
|
1292
|
+
productId?: number;
|
|
1293
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1294
|
+
product: Product;
|
|
1295
|
+
}>>;
|
|
1296
|
+
/**
|
|
1297
|
+
* Product Detail
|
|
1298
|
+
* @schema ProductDetailReq
|
|
1299
|
+
*/
|
|
1300
|
+
productDetail(body: ProductDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
1301
|
+
product: Product;
|
|
1302
|
+
}>>;
|
|
1303
|
+
/**
|
|
1304
|
+
* Edit Product
|
|
1305
|
+
* @schema ProductEditReq
|
|
1306
|
+
*/
|
|
1307
|
+
productEdit(body: ProductEditReq): Promise<import("./types/shared").StdResponse<{
|
|
1308
|
+
product: Product;
|
|
1309
|
+
}>>;
|
|
1310
|
+
/**
|
|
1311
|
+
* Inactivate Product
|
|
1312
|
+
* @schema ProductInactiveReq
|
|
1313
|
+
*/
|
|
1314
|
+
productInactivate(body: ProductInactiveReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1315
|
+
/**
|
|
1316
|
+
* Get Product List
|
|
1317
|
+
* @status number[] Filter, Default All,,Status,1-active,2-inactive
|
|
1318
|
+
* @sortField string Sort Field,id|create_time|gmt_modify,Default id
|
|
1319
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
1320
|
+
* @page number Page, Start 0
|
|
1321
|
+
* @count number Count Of Per Page
|
|
1322
|
+
*/
|
|
1323
|
+
getProductList(params: {
|
|
1324
|
+
status?: number[];
|
|
1325
|
+
sortField?: string;
|
|
1326
|
+
sortType?: string;
|
|
1327
|
+
page?: number;
|
|
1328
|
+
count?: number;
|
|
1329
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1330
|
+
products: Product[];
|
|
1331
|
+
total: number;
|
|
1332
|
+
}>>;
|
|
1333
|
+
/**
|
|
1334
|
+
* Get Product List
|
|
1335
|
+
* @schema ProductListReq
|
|
1336
|
+
*/
|
|
1337
|
+
productList(body: ProductListReq): Promise<import("./types/shared").StdResponse<{
|
|
1338
|
+
products: Product[];
|
|
1339
|
+
total: number;
|
|
1340
|
+
}>>;
|
|
1341
|
+
/**
|
|
1342
|
+
* Create Product
|
|
1343
|
+
* @schema ProductNewReq
|
|
1344
|
+
*/
|
|
1345
|
+
productNew(body: ProductNewReq): Promise<import("./types/shared").StdResponse<{
|
|
1346
|
+
product: Product;
|
|
1347
|
+
}>>;
|
|
1348
|
+
/**
|
|
1349
|
+
* Delete Role
|
|
1350
|
+
* @schema RoleDeleteReq
|
|
1351
|
+
*/
|
|
1352
|
+
roleDelete(body: RoleDeleteReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1353
|
+
/**
|
|
1354
|
+
* Edit Role
|
|
1355
|
+
* @schema RoleEditReq
|
|
1356
|
+
*/
|
|
1357
|
+
roleEdit(body: RoleEditReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1358
|
+
/**
|
|
1359
|
+
* Get Role List
|
|
1360
|
+
*/
|
|
1361
|
+
getRoleList(): Promise<import("./types/shared").StdResponse<{
|
|
1362
|
+
merchantRoles: MerchantRole[];
|
|
1363
|
+
total: number;
|
|
1364
|
+
}>>;
|
|
1365
|
+
/**
|
|
1366
|
+
* New Role
|
|
1367
|
+
* @schema RoleNewReq
|
|
1368
|
+
*/
|
|
1369
|
+
roleNew(body: RoleNewReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1370
|
+
/**
|
|
1371
|
+
* Search
|
|
1372
|
+
* @searchKey string SearchKey, Will Search UserId|Email|UserName|CompanyName|SubscriptionId|VatNumber|InvoiceId||PaymentId
|
|
1373
|
+
*/
|
|
1374
|
+
getSearchKeySearch(params: {
|
|
1375
|
+
searchKey?: string;
|
|
1376
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1377
|
+
precisionMatchObject: SearchPrecisionMatchObject;
|
|
1378
|
+
matchUserAccounts: DetailUserAccountDetail[];
|
|
1379
|
+
matchInvoice: Invoice[];
|
|
1380
|
+
}>>;
|
|
1381
|
+
/**
|
|
1382
|
+
* Search
|
|
1383
|
+
* @schema SearchSearchReq
|
|
1384
|
+
*/
|
|
1385
|
+
searchKeySearch(body: SearchSearchReq): Promise<import("./types/shared").StdResponse<{
|
|
1386
|
+
precisionMatchObject: SearchPrecisionMatchObject;
|
|
1387
|
+
matchUserAccounts: DetailUserAccountDetail[];
|
|
1388
|
+
matchInvoice: Invoice[];
|
|
1389
|
+
}>>;
|
|
1390
|
+
/**
|
|
1391
|
+
* New Session
|
|
1392
|
+
* @schema SessionNewReq
|
|
1393
|
+
*/
|
|
1394
|
+
sessionNewSession(body: SessionNewReq): Promise<import("./types/shared").StdResponse<{
|
|
1395
|
+
userId: string;
|
|
1396
|
+
externalUserId: string;
|
|
1397
|
+
email: string;
|
|
1398
|
+
url: string;
|
|
1399
|
+
clientToken: string;
|
|
1400
|
+
clientSession: string;
|
|
1401
|
+
}>>;
|
|
1402
|
+
/**
|
|
1403
|
+
* Subscription Active Temporarily
|
|
1404
|
+
* @schema SubscriptionActiveTemporarilyReq
|
|
1405
|
+
*/
|
|
1406
|
+
subscriptionActiveTemporarily(body: SubscriptionActiveTemporarilyReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1407
|
+
/**
|
|
1408
|
+
* Append Subscription TrialEnd
|
|
1409
|
+
* @schema SubscriptionAddNewTrialStartReq
|
|
1410
|
+
*/
|
|
1411
|
+
subscriptionAddNewTrialStart(body: SubscriptionAddNewTrialStartReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1412
|
+
/**
|
|
1413
|
+
* Get Subscription Note List
|
|
1414
|
+
* @subscriptionId string SubscriptionId
|
|
1415
|
+
* @page number Page, Start With 0
|
|
1416
|
+
* @count number Count Of Page
|
|
1417
|
+
*/
|
|
1418
|
+
getSubscriptionAdminNoteList(params: {
|
|
1419
|
+
subscriptionId?: string;
|
|
1420
|
+
page?: number;
|
|
1421
|
+
count?: number;
|
|
1422
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1423
|
+
noteLists: SubscriptionAdminNoteRo[];
|
|
1424
|
+
}>>;
|
|
1425
|
+
/**
|
|
1426
|
+
* Get Subscription Note List
|
|
1427
|
+
* @schema SubscriptionAdminNoteListReq
|
|
1428
|
+
*/
|
|
1429
|
+
subscriptionAdminNoteList(body: SubscriptionAdminNoteListReq): Promise<import("./types/shared").StdResponse<{
|
|
1430
|
+
noteLists: SubscriptionAdminNoteRo[];
|
|
1431
|
+
}>>;
|
|
1432
|
+
/**
|
|
1433
|
+
* Cancel Subscription Immediately
|
|
1434
|
+
* @schema SubscriptionCancelReq
|
|
1435
|
+
*/
|
|
1436
|
+
subscriptionCancel(body: SubscriptionCancelReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1437
|
+
/**
|
|
1438
|
+
* Cancel Subscription At Period End
|
|
1439
|
+
* @schema SubscriptionCancelAtPeriodEndReq
|
|
1440
|
+
*/
|
|
1441
|
+
subscriptionCancelAtPeriodEnd(body: SubscriptionCancelAtPeriodEndReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1442
|
+
/**
|
|
1443
|
+
* Cancel Last Cancel Subscription At Period End
|
|
1444
|
+
* @schema SubscriptionCancelLastCancelAtPeriodEndReq
|
|
1445
|
+
*/
|
|
1446
|
+
subscriptionCancelLastCancelAtPeriodEnd(body: SubscriptionCancelLastCancelAtPeriodEndReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1447
|
+
/**
|
|
1448
|
+
* Change Subscription Gateway
|
|
1449
|
+
* @schema SubscriptionChangeGatewayReq
|
|
1450
|
+
*/
|
|
1451
|
+
subscriptionChangeGateway(body: SubscriptionChangeGatewayReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1452
|
+
/**
|
|
1453
|
+
* Subscription Config
|
|
1454
|
+
*/
|
|
1455
|
+
getSubscriptionConfig(): Promise<import("./types/shared").StdResponse<{
|
|
1456
|
+
config: SubscriptionConfig;
|
|
1457
|
+
}>>;
|
|
1458
|
+
/**
|
|
1459
|
+
* Update Merchant Subscription Config
|
|
1460
|
+
* @schema SubscriptionConfigUpdateReq
|
|
1461
|
+
*/
|
|
1462
|
+
subscriptionConfigUpdate(body: SubscriptionConfigUpdateReq): Promise<import("./types/shared").StdResponse<{
|
|
1463
|
+
config: SubscriptionConfig;
|
|
1464
|
+
}>>;
|
|
1465
|
+
/**
|
|
1466
|
+
* Create Subscription Preview
|
|
1467
|
+
* @schema SubscriptionCreatePreviewReq
|
|
1468
|
+
*/
|
|
1469
|
+
subscriptionCreatePreview(body: SubscriptionCreatePreviewReq): Promise<import("./types/shared").StdResponse<{
|
|
1470
|
+
plan: Plan;
|
|
1471
|
+
trialEnd: number;
|
|
1472
|
+
quantity: number;
|
|
1473
|
+
gateway: DetailGateway;
|
|
1474
|
+
addonParams: PlanAddonParam[];
|
|
1475
|
+
addons: PlanAddonDetail[];
|
|
1476
|
+
subscriptionAmountExcludingTax: number;
|
|
1477
|
+
taxAmount: number;
|
|
1478
|
+
discountAmount: number;
|
|
1479
|
+
totalAmount: number;
|
|
1480
|
+
originAmount: number;
|
|
1481
|
+
currency: string;
|
|
1482
|
+
invoice: Invoice;
|
|
1483
|
+
userId: number;
|
|
1484
|
+
email: string;
|
|
1485
|
+
vatCountryCode: string;
|
|
1486
|
+
vatCountryName: string;
|
|
1487
|
+
taxPercentage: number;
|
|
1488
|
+
vatNumber: string;
|
|
1489
|
+
vatNumberValidate: ValidResult;
|
|
1490
|
+
discount: MerchantDiscountCode;
|
|
1491
|
+
vatNumberValidateMessage: string;
|
|
1492
|
+
discountMessage: string;
|
|
1493
|
+
otherPendingCryptoSubscription: DetailSubscriptionDetail;
|
|
1494
|
+
otherActiveSubscriptionId: string;
|
|
1495
|
+
applyPromoCredit: boolean;
|
|
1496
|
+
}>>;
|
|
1497
|
+
/**
|
|
1498
|
+
* Create Subscription
|
|
1499
|
+
* @schema SubscriptionCreateReq
|
|
1500
|
+
*/
|
|
1501
|
+
subscriptionCreateSubmit(body: SubscriptionCreateReq): Promise<import("./types/shared").StdResponse<{
|
|
1502
|
+
subscription: Subscription;
|
|
1503
|
+
user: UserAccount;
|
|
1504
|
+
paid: boolean;
|
|
1505
|
+
link: string;
|
|
1506
|
+
token: string;
|
|
1507
|
+
otherPendingCryptoSubscription: DetailSubscriptionDetail;
|
|
1508
|
+
}>>;
|
|
1509
|
+
/**
|
|
1510
|
+
* Subscription Detail
|
|
1511
|
+
* @subscriptionId string SubscriptionId
|
|
1512
|
+
*/
|
|
1513
|
+
getSubscriptionDetail(params: {
|
|
1514
|
+
subscriptionId?: string;
|
|
1515
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1516
|
+
user: UserAccount;
|
|
1517
|
+
subscription: Subscription;
|
|
1518
|
+
plan: Plan;
|
|
1519
|
+
gateway: DetailGateway;
|
|
1520
|
+
addonParams: PlanAddonParam[];
|
|
1521
|
+
addons: PlanAddonDetail[];
|
|
1522
|
+
latestInvoice: Invoice;
|
|
1523
|
+
unfinishedSubscriptionPendingUpdate: DetailSubscriptionPendingUpdateDetail;
|
|
1524
|
+
}>>;
|
|
1525
|
+
/**
|
|
1526
|
+
* Subscription Detail
|
|
1527
|
+
* @schema SubscriptionDetailReq
|
|
1528
|
+
*/
|
|
1529
|
+
subscriptionDetail(body: SubscriptionDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
1530
|
+
user: UserAccount;
|
|
1531
|
+
subscription: Subscription;
|
|
1532
|
+
plan: Plan;
|
|
1533
|
+
gateway: DetailGateway;
|
|
1534
|
+
addonParams: PlanAddonParam[];
|
|
1535
|
+
addons: PlanAddonDetail[];
|
|
1536
|
+
latestInvoice: Invoice;
|
|
1537
|
+
unfinishedSubscriptionPendingUpdate: DetailSubscriptionPendingUpdateDetail;
|
|
1538
|
+
}>>;
|
|
1539
|
+
/**
|
|
1540
|
+
* Get Subscription List
|
|
1541
|
+
* @userId number UserId
|
|
1542
|
+
* @status number[] Filter, Default All,Status,1-Pending|2-Active|3-Suspend | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9-Failed
|
|
1543
|
+
* @currency string The currency of subscription
|
|
1544
|
+
* @planIds number[] The filter ids of plan
|
|
1545
|
+
* @productIds number[] The filter ids of product
|
|
1546
|
+
* @amountStart number The filter start amount of subscription
|
|
1547
|
+
* @amountEnd number The filter end amount of subscription
|
|
1548
|
+
* @sortField string Sort Field,gmt_create|gmt_modify,Default gmt_modify
|
|
1549
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
1550
|
+
* @page number Page, Start With 0
|
|
1551
|
+
* @count number Count Of Page
|
|
1552
|
+
* @createTimeStart number CreateTimeStart
|
|
1553
|
+
* @createTimeEnd number CreateTimeEnd
|
|
1554
|
+
*/
|
|
1555
|
+
getSubscriptionList(params: {
|
|
1556
|
+
userId?: number;
|
|
1557
|
+
status?: number[];
|
|
1558
|
+
currency?: string;
|
|
1559
|
+
planIds?: number[];
|
|
1560
|
+
productIds?: number[];
|
|
1561
|
+
amountStart?: number;
|
|
1562
|
+
amountEnd?: number;
|
|
1563
|
+
sortField?: string;
|
|
1564
|
+
sortType?: string;
|
|
1565
|
+
page?: number;
|
|
1566
|
+
count?: number;
|
|
1567
|
+
createTimeStart?: number;
|
|
1568
|
+
createTimeEnd?: number;
|
|
1569
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1570
|
+
subscriptions: DetailSubscriptionDetail[];
|
|
1571
|
+
total: number;
|
|
1572
|
+
}>>;
|
|
1573
|
+
/**
|
|
1574
|
+
* Get Subscription List
|
|
1575
|
+
* @schema SubscriptionListReq
|
|
1576
|
+
*/
|
|
1577
|
+
subscriptionList(body: SubscriptionListReq): Promise<import("./types/shared").StdResponse<{
|
|
1578
|
+
subscriptions: DetailSubscriptionDetail[];
|
|
1579
|
+
total: number;
|
|
1580
|
+
}>>;
|
|
1581
|
+
/**
|
|
1582
|
+
* New Subscription Note
|
|
1583
|
+
* @schema SubscriptionNewAdminNoteReq
|
|
1584
|
+
*/
|
|
1585
|
+
subscriptionNewAdminNote(body: SubscriptionNewAdminNoteReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1586
|
+
/**
|
|
1587
|
+
* New Subscription Onetime Addon Payment
|
|
1588
|
+
* @schema SubscriptionOnetimeAddonNewReq
|
|
1589
|
+
*/
|
|
1590
|
+
subscriptionNewOnetimeAddonPayment(body: SubscriptionOnetimeAddonNewReq): Promise<import("./types/shared").StdResponse<{
|
|
1591
|
+
subscriptionOnetimeAddon: SubscriptionOnetimeAddon;
|
|
1592
|
+
paid: boolean;
|
|
1593
|
+
link: string;
|
|
1594
|
+
invoice: Invoice;
|
|
1595
|
+
}>>;
|
|
1596
|
+
/**
|
|
1597
|
+
* Get Subscription Onetime Addon List
|
|
1598
|
+
* @userId number UserId
|
|
1599
|
+
* @page number Page, Start With 0
|
|
1600
|
+
* @count number Count Of Page
|
|
1601
|
+
*/
|
|
1602
|
+
getSubscriptionOnetimeAddonList(params: {
|
|
1603
|
+
userId?: number;
|
|
1604
|
+
page?: number;
|
|
1605
|
+
count?: number;
|
|
1606
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1607
|
+
subscriptionOnetimeAddons: DetailSubscriptionOnetimeAddonDetail[];
|
|
1608
|
+
}>>;
|
|
1609
|
+
/**
|
|
1610
|
+
* New Subscription Payment
|
|
1611
|
+
* @schema SubscriptionNewPaymentReq
|
|
1612
|
+
*/
|
|
1613
|
+
subscriptionPaymentNew(body: SubscriptionNewPaymentReq): Promise<import("./types/shared").StdResponse<{
|
|
1614
|
+
status: number;
|
|
1615
|
+
paymentId: string;
|
|
1616
|
+
externalPaymentId: string;
|
|
1617
|
+
link: string;
|
|
1618
|
+
action: any;
|
|
1619
|
+
}>>;
|
|
1620
|
+
/**
|
|
1621
|
+
* Subscription Pending Update Detail
|
|
1622
|
+
* @subscriptionPendingUpdateId string SubscriptionPendingUpdateId
|
|
1623
|
+
*/
|
|
1624
|
+
getSubscriptionPendingUpdateDetail(params: {
|
|
1625
|
+
subscriptionPendingUpdateId?: string;
|
|
1626
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1627
|
+
SubscriptionPendingUpdate: DetailSubscriptionPendingUpdateDetail;
|
|
1628
|
+
}>>;
|
|
1629
|
+
/**
|
|
1630
|
+
* Get Subscription Pending Update List
|
|
1631
|
+
* @subscriptionId string SubscriptionId
|
|
1632
|
+
* @sortField string Sort Field,gmt_create|gmt_modify,Default gmt_modify
|
|
1633
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
1634
|
+
* @page number Page, Start With 0
|
|
1635
|
+
* @count number Count Of Page
|
|
1636
|
+
*/
|
|
1637
|
+
getSubscriptionPendingUpdateList(params: {
|
|
1638
|
+
subscriptionId?: string;
|
|
1639
|
+
sortField?: string;
|
|
1640
|
+
sortType?: string;
|
|
1641
|
+
page?: number;
|
|
1642
|
+
count?: number;
|
|
1643
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1644
|
+
subscriptionPendingUpdateDetails: DetailSubscriptionPendingUpdateDetail[];
|
|
1645
|
+
total: number;
|
|
1646
|
+
}>>;
|
|
1647
|
+
/**
|
|
1648
|
+
* Get Subscription Pending Update List
|
|
1649
|
+
* @schema SubscriptionPendingUpdateListReq
|
|
1650
|
+
*/
|
|
1651
|
+
subscriptionPendingUpdateList(body: SubscriptionPendingUpdateListReq): Promise<import("./types/shared").StdResponse<{
|
|
1652
|
+
subscriptionPendingUpdateDetails: DetailSubscriptionPendingUpdateDetail[];
|
|
1653
|
+
total: number;
|
|
1654
|
+
}>>;
|
|
1655
|
+
/**
|
|
1656
|
+
* Subscription Next Invoice Preview
|
|
1657
|
+
* @subscriptionId string SubscriptionId
|
|
1658
|
+
*/
|
|
1659
|
+
getSubscriptionPreviewSubscriptionNextInvoice(params: {
|
|
1660
|
+
subscriptionId?: string;
|
|
1661
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1662
|
+
subscription: Subscription;
|
|
1663
|
+
invoice: Invoice;
|
|
1664
|
+
subscriptionPendingUpdate: DetailSubscriptionPendingUpdateDetail;
|
|
1665
|
+
}>>;
|
|
1666
|
+
/**
|
|
1667
|
+
* Renew Subscription
|
|
1668
|
+
* @schema SubscriptionRenewReq
|
|
1669
|
+
*/
|
|
1670
|
+
subscriptionRenew(body: SubscriptionRenewReq): Promise<import("./types/shared").StdResponse<{
|
|
1671
|
+
subscription: Subscription;
|
|
1672
|
+
paid: boolean;
|
|
1673
|
+
link: string;
|
|
1674
|
+
}>>;
|
|
1675
|
+
/**
|
|
1676
|
+
* Get Subscription TimeLine List
|
|
1677
|
+
* @userId number Filter UserId, Default All
|
|
1678
|
+
* @sortField string Sort Field,gmt_create|gmt_modify,Default gmt_modify
|
|
1679
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
1680
|
+
* @page number Page, Start With 0
|
|
1681
|
+
* @count number Count Of Page
|
|
1682
|
+
*/
|
|
1683
|
+
getSubscriptionTimelineList(params: {
|
|
1684
|
+
userId?: number;
|
|
1685
|
+
sortField?: string;
|
|
1686
|
+
sortType?: string;
|
|
1687
|
+
page?: number;
|
|
1688
|
+
count?: number;
|
|
1689
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1690
|
+
subscriptionTimeLines: DetailSubscriptionTimeLineDetail[];
|
|
1691
|
+
total: number;
|
|
1692
|
+
}>>;
|
|
1693
|
+
/**
|
|
1694
|
+
* Get Subscription TimeLine List
|
|
1695
|
+
* @schema SubscriptionTimeLineListReq
|
|
1696
|
+
*/
|
|
1697
|
+
subscriptionTimelineList(body: SubscriptionTimeLineListReq): Promise<import("./types/shared").StdResponse<{
|
|
1698
|
+
subscriptionTimeLines: DetailSubscriptionTimeLineDetail[];
|
|
1699
|
+
total: number;
|
|
1700
|
+
}>>;
|
|
1701
|
+
/**
|
|
1702
|
+
* Update Subscription Preview
|
|
1703
|
+
* @schema SubscriptionUpdatePreviewReq
|
|
1704
|
+
*/
|
|
1705
|
+
subscriptionUpdatePreview(body: SubscriptionUpdatePreviewReq): Promise<import("./types/shared").StdResponse<{
|
|
1706
|
+
originAmount: number;
|
|
1707
|
+
totalAmount: number;
|
|
1708
|
+
discountAmount: number;
|
|
1709
|
+
currency: string;
|
|
1710
|
+
invoice: Invoice;
|
|
1711
|
+
nextPeriodInvoice: Invoice;
|
|
1712
|
+
prorationDate: number;
|
|
1713
|
+
discount: MerchantDiscountCode;
|
|
1714
|
+
discountMessage: string;
|
|
1715
|
+
applyPromoCredit: boolean;
|
|
1716
|
+
}>>;
|
|
1717
|
+
/**
|
|
1718
|
+
* Update Subscription
|
|
1719
|
+
* @schema SubscriptionUpdateReq
|
|
1720
|
+
*/
|
|
1721
|
+
subscriptionUpdateSubmit(body: SubscriptionUpdateReq): Promise<import("./types/shared").StdResponse<{
|
|
1722
|
+
subscriptionPendingUpdate: DetailSubscriptionPendingUpdateDetail;
|
|
1723
|
+
paid: boolean;
|
|
1724
|
+
link: string;
|
|
1725
|
+
note: string;
|
|
1726
|
+
}>>;
|
|
1727
|
+
/**
|
|
1728
|
+
* User Pending Crypto Subscription Detail
|
|
1729
|
+
* @userId number UserId
|
|
1730
|
+
* @externalUserId string ExternalUserId, unique, either ExternalUserId&Email or UserId needed
|
|
1731
|
+
* @productId number default product will use if productId not specified and subscriptionId is blank
|
|
1732
|
+
*/
|
|
1733
|
+
getSubscriptionUserPendingCryptoSubscriptionDetail(params: {
|
|
1734
|
+
userId?: number;
|
|
1735
|
+
externalUserId?: string;
|
|
1736
|
+
productId?: number;
|
|
1737
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1738
|
+
subscription: DetailSubscriptionDetail;
|
|
1739
|
+
}>>;
|
|
1740
|
+
/**
|
|
1741
|
+
* User Pending Crypto Subscription Detail
|
|
1742
|
+
* @schema SubscriptionUserPendingCryptoSubscriptionDetailReq
|
|
1743
|
+
*/
|
|
1744
|
+
subscriptionUserPendingCryptoSubscriptionDetail(body: SubscriptionUserPendingCryptoSubscriptionDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
1745
|
+
subscription: DetailSubscriptionDetail;
|
|
1746
|
+
}>>;
|
|
1747
|
+
/**
|
|
1748
|
+
* User Subscription Detail
|
|
1749
|
+
* @userId number UserId
|
|
1750
|
+
* @externalUserId string ExternalUserId, unique, either ExternalUserId&Email or UserId needed
|
|
1751
|
+
* @productId number default product will use if productId not specified and subscriptionId is blank
|
|
1752
|
+
*/
|
|
1753
|
+
getSubscriptionUserSubscriptionDetail(params: {
|
|
1754
|
+
userId?: number;
|
|
1755
|
+
externalUserId?: string;
|
|
1756
|
+
productId?: number;
|
|
1757
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1758
|
+
user: UserAccount;
|
|
1759
|
+
subscription: Subscription;
|
|
1760
|
+
plan: Plan;
|
|
1761
|
+
gateway: DetailGateway;
|
|
1762
|
+
addons: PlanAddonDetail[];
|
|
1763
|
+
latestInvoice: Invoice;
|
|
1764
|
+
unfinishedSubscriptionPendingUpdate: DetailSubscriptionPendingUpdateDetail;
|
|
1765
|
+
}>>;
|
|
1766
|
+
/**
|
|
1767
|
+
* User Subscription Detail
|
|
1768
|
+
* @schema SubscriptionUserSubscriptionDetailReq
|
|
1769
|
+
*/
|
|
1770
|
+
subscriptionUserSubscriptionDetail(body: SubscriptionUserSubscriptionDetailReq): Promise<import("./types/shared").StdResponse<{
|
|
1771
|
+
user: UserAccount;
|
|
1772
|
+
subscription: Subscription;
|
|
1773
|
+
plan: Plan;
|
|
1774
|
+
gateway: DetailGateway;
|
|
1775
|
+
addons: PlanAddonDetail[];
|
|
1776
|
+
latestInvoice: Invoice;
|
|
1777
|
+
unfinishedSubscriptionPendingUpdate: DetailSubscriptionPendingUpdateDetail;
|
|
1778
|
+
}>>;
|
|
1779
|
+
/**
|
|
1780
|
+
* Delete Export Template
|
|
1781
|
+
* @schema TaskDeleteTemplateReq
|
|
1782
|
+
*/
|
|
1783
|
+
taskDeleteExportTemplate(body: TaskDeleteTemplateReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1784
|
+
/**
|
|
1785
|
+
* Edit Export Template
|
|
1786
|
+
* @schema TaskEditTemplateReq
|
|
1787
|
+
*/
|
|
1788
|
+
taskEditExportTemplate(body: TaskEditTemplateReq): Promise<import("./types/shared").StdResponse<{
|
|
1789
|
+
template: MerchantBatchExportTemplate;
|
|
1790
|
+
}>>;
|
|
1791
|
+
/**
|
|
1792
|
+
* Export Column List
|
|
1793
|
+
* @schema TaskExportColumnListReq
|
|
1794
|
+
*/
|
|
1795
|
+
taskExportColumnList(body: TaskExportColumnListReq): Promise<import("./types/shared").StdResponse<{
|
|
1796
|
+
columns: any[];
|
|
1797
|
+
groupColumns: Record<string, any>;
|
|
1798
|
+
columnHeaders: Record<string, string>;
|
|
1799
|
+
columnComments: Record<string, string>;
|
|
1800
|
+
}>>;
|
|
1801
|
+
/**
|
|
1802
|
+
* Get Export Template List
|
|
1803
|
+
* @task string Filter Task, Optional, InvoiceExport|UserExport|SubscriptionExport|TransactionExport|DiscountExport|UserDiscountExport
|
|
1804
|
+
* @page number Page, Start With 0
|
|
1805
|
+
* @count number Count Of Page
|
|
1806
|
+
*/
|
|
1807
|
+
getTaskExportTemplateList(params: {
|
|
1808
|
+
task?: string;
|
|
1809
|
+
page?: number;
|
|
1810
|
+
count?: number;
|
|
1811
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1812
|
+
templates: MerchantBatchExportTemplate[];
|
|
1813
|
+
total: number;
|
|
1814
|
+
}>>;
|
|
1815
|
+
/**
|
|
1816
|
+
* Get Export Template List
|
|
1817
|
+
* @schema TaskExportTemplateListReq
|
|
1818
|
+
*/
|
|
1819
|
+
taskExportTemplateList(body: TaskExportTemplateListReq): Promise<import("./types/shared").StdResponse<{
|
|
1820
|
+
templates: MerchantBatchExportTemplate[];
|
|
1821
|
+
total: number;
|
|
1822
|
+
}>>;
|
|
1823
|
+
/**
|
|
1824
|
+
* Get Task List
|
|
1825
|
+
* @page number Page, Start With 0
|
|
1826
|
+
* @count number Count Of Page
|
|
1827
|
+
*/
|
|
1828
|
+
getTaskList(params: {
|
|
1829
|
+
page?: number;
|
|
1830
|
+
count?: number;
|
|
1831
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1832
|
+
downloads: MerchantBatchTask[];
|
|
1833
|
+
total: number;
|
|
1834
|
+
}>>;
|
|
1835
|
+
/**
|
|
1836
|
+
* Get Task List
|
|
1837
|
+
* @schema TaskListReq
|
|
1838
|
+
*/
|
|
1839
|
+
taskList(body: TaskListReq): Promise<import("./types/shared").StdResponse<{
|
|
1840
|
+
downloads: MerchantBatchTask[];
|
|
1841
|
+
total: number;
|
|
1842
|
+
}>>;
|
|
1843
|
+
/**
|
|
1844
|
+
* New Export
|
|
1845
|
+
* @schema TaskNewReq
|
|
1846
|
+
*/
|
|
1847
|
+
taskNewExport(body: TaskNewReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1848
|
+
/**
|
|
1849
|
+
* New Export Template
|
|
1850
|
+
* @schema TaskNewTemplateReq
|
|
1851
|
+
*/
|
|
1852
|
+
taskNewExportTemplate(body: TaskNewTemplateReq): Promise<import("./types/shared").StdResponse<{
|
|
1853
|
+
template: MerchantBatchExportTemplate;
|
|
1854
|
+
}>>;
|
|
1855
|
+
/**
|
|
1856
|
+
* New Import
|
|
1857
|
+
*/
|
|
1858
|
+
taskNewImport(): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1859
|
+
/**
|
|
1860
|
+
* Segment Setup
|
|
1861
|
+
* @schema TrackSetupSegmentReq
|
|
1862
|
+
*/
|
|
1863
|
+
trackSetupSegment(body: TrackSetupSegmentReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1864
|
+
/**
|
|
1865
|
+
* Update Profile
|
|
1866
|
+
* @schema ProfileUpdateReq
|
|
1867
|
+
*/
|
|
1868
|
+
update(body: ProfileUpdateReq): Promise<import("./types/shared").StdResponse<{
|
|
1869
|
+
merchant: Merchant;
|
|
1870
|
+
}>>;
|
|
1871
|
+
/**
|
|
1872
|
+
* Get User Admin Note List
|
|
1873
|
+
* @userId number The id of user, either ExternalUserId or UserId needed
|
|
1874
|
+
* @page number Page, Start With 0
|
|
1875
|
+
* @count number Count Of Page
|
|
1876
|
+
*/
|
|
1877
|
+
getUserAdminNoteList(params: {
|
|
1878
|
+
userId?: number;
|
|
1879
|
+
page?: number;
|
|
1880
|
+
count?: number;
|
|
1881
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1882
|
+
noteLists: DetailUserAdminNoteDetail[];
|
|
1883
|
+
}>>;
|
|
1884
|
+
/**
|
|
1885
|
+
* Get User Admin Note List
|
|
1886
|
+
* @schema UserAdminNoteListReq
|
|
1887
|
+
*/
|
|
1888
|
+
userAdminNoteList(body: UserAdminNoteListReq): Promise<import("./types/shared").StdResponse<{
|
|
1889
|
+
noteLists: DetailUserAdminNoteDetail[];
|
|
1890
|
+
}>>;
|
|
1891
|
+
/**
|
|
1892
|
+
* Change User Email
|
|
1893
|
+
* @schema UserChangeEmailReq
|
|
1894
|
+
*/
|
|
1895
|
+
userChangeEmail(body: UserChangeEmailReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1896
|
+
/**
|
|
1897
|
+
* Change User Default Gateway
|
|
1898
|
+
* @schema UserChangeGatewayReq
|
|
1899
|
+
*/
|
|
1900
|
+
userChangeGateway(body: UserChangeGatewayReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1901
|
+
/**
|
|
1902
|
+
* Clear AutoCharge Method
|
|
1903
|
+
* @schema UserClearAutoChargeMethodReq
|
|
1904
|
+
*/
|
|
1905
|
+
userClearAutoChargeMethod(body: UserClearAutoChargeMethodReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1906
|
+
/**
|
|
1907
|
+
* Get User Profile
|
|
1908
|
+
* @userId number UserId
|
|
1909
|
+
*/
|
|
1910
|
+
getUserGet(params: {
|
|
1911
|
+
userId?: number;
|
|
1912
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1913
|
+
user: DetailUserAccountDetail;
|
|
1914
|
+
}>>;
|
|
1915
|
+
/**
|
|
1916
|
+
* User List
|
|
1917
|
+
* @userId number Filter UserId
|
|
1918
|
+
* @firstName string Search FirstName
|
|
1919
|
+
* @lastName string Search LastName
|
|
1920
|
+
* @email string Search Filter Email
|
|
1921
|
+
* @planIds number[] PlanIds, Search Filter PlanIds
|
|
1922
|
+
* @subscriptionId string Search Filter SubscriptionId
|
|
1923
|
+
* @subStatus number[] Filter, Default All,1-Pending|2-Active|3-Suspend | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9-Failed
|
|
1924
|
+
* @status number[] Status, 0-Active|2-Frozen
|
|
1925
|
+
* @deleteInclude boolean Deleted Involved,Need Admin
|
|
1926
|
+
* @sortField string Sort,user_id|gmt_create|email|user_name|subscription_name|subscription_status|payment_method|recurring_amount|billing_type,Default gmt_create
|
|
1927
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
1928
|
+
* @page number Page,Start 0
|
|
1929
|
+
* @count number Count OF Page
|
|
1930
|
+
* @createTimeStart number CreateTimeStart
|
|
1931
|
+
* @createTimeEnd number CreateTimeEnd
|
|
1932
|
+
*/
|
|
1933
|
+
getUserList(params: {
|
|
1934
|
+
userId?: number;
|
|
1935
|
+
firstName?: string;
|
|
1936
|
+
lastName?: string;
|
|
1937
|
+
email?: string;
|
|
1938
|
+
planIds?: number[];
|
|
1939
|
+
subscriptionId?: string;
|
|
1940
|
+
subStatus?: number[];
|
|
1941
|
+
status?: number[];
|
|
1942
|
+
deleteInclude?: boolean;
|
|
1943
|
+
sortField?: string;
|
|
1944
|
+
sortType?: string;
|
|
1945
|
+
page?: number;
|
|
1946
|
+
count?: number;
|
|
1947
|
+
createTimeStart?: number;
|
|
1948
|
+
createTimeEnd?: number;
|
|
1949
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1950
|
+
userAccounts: DetailUserAccountDetail[];
|
|
1951
|
+
total: number;
|
|
1952
|
+
}>>;
|
|
1953
|
+
/**
|
|
1954
|
+
* User List
|
|
1955
|
+
* @schema UserListReq
|
|
1956
|
+
*/
|
|
1957
|
+
userList(body: UserListReq): Promise<import("./types/shared").StdResponse<{
|
|
1958
|
+
userAccounts: DetailUserAccountDetail[];
|
|
1959
|
+
total: number;
|
|
1960
|
+
}>>;
|
|
1961
|
+
/**
|
|
1962
|
+
* New User
|
|
1963
|
+
* @schema UserNewReq
|
|
1964
|
+
*/
|
|
1965
|
+
userNew(body: UserNewReq): Promise<import("./types/shared").StdResponse<{
|
|
1966
|
+
user: UserAccount;
|
|
1967
|
+
}>>;
|
|
1968
|
+
/**
|
|
1969
|
+
* New Admin Note
|
|
1970
|
+
* @schema UserNewAdminNoteReq
|
|
1971
|
+
*/
|
|
1972
|
+
userNewAdminNote(body: UserNewAdminNoteReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1973
|
+
/**
|
|
1974
|
+
* Resume User
|
|
1975
|
+
* @schema UserReleaseReq
|
|
1976
|
+
*/
|
|
1977
|
+
userResumeUser(body: UserReleaseReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1978
|
+
/**
|
|
1979
|
+
* User Search
|
|
1980
|
+
* @searchKey string SearchKey, Will Search UserId|Email|UserName|CompanyName|SubscriptionId|VatNumber|InvoiceId||PaymentId
|
|
1981
|
+
*/
|
|
1982
|
+
getUserSearch(params: {
|
|
1983
|
+
searchKey?: string;
|
|
1984
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
1985
|
+
userAccounts: DetailUserAccountDetail[];
|
|
1986
|
+
}>>;
|
|
1987
|
+
/**
|
|
1988
|
+
* User Search
|
|
1989
|
+
* @schema UserSearchReq
|
|
1990
|
+
*/
|
|
1991
|
+
userSearch(body: UserSearchReq): Promise<import("./types/shared").StdResponse<{
|
|
1992
|
+
userAccounts: DetailUserAccountDetail[];
|
|
1993
|
+
}>>;
|
|
1994
|
+
/**
|
|
1995
|
+
* Suspend User
|
|
1996
|
+
* @schema UserFrozenReq
|
|
1997
|
+
*/
|
|
1998
|
+
userSuspendUser(body: UserFrozenReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
1999
|
+
/**
|
|
2000
|
+
* Update User Profile
|
|
2001
|
+
* @schema UserUpdateReq
|
|
2002
|
+
*/
|
|
2003
|
+
userUpdate(body: UserUpdateReq): Promise<import("./types/shared").StdResponse<{
|
|
2004
|
+
user: DetailUserAccountDetail;
|
|
2005
|
+
}>>;
|
|
2006
|
+
/**
|
|
2007
|
+
* User Wallet List
|
|
2008
|
+
* @userId number The id of user
|
|
2009
|
+
*/
|
|
2010
|
+
getUserWalletList(params: {
|
|
2011
|
+
userId?: number;
|
|
2012
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
2013
|
+
wallet_list: UserWallet[];
|
|
2014
|
+
}>>;
|
|
2015
|
+
/**
|
|
2016
|
+
* User Wallet List
|
|
2017
|
+
* @schema UserWalletListReq
|
|
2018
|
+
*/
|
|
2019
|
+
userWalletList(body: UserWalletListReq): Promise<import("./types/shared").StdResponse<{
|
|
2020
|
+
wallet_list: UserWallet[];
|
|
2021
|
+
}>>;
|
|
2022
|
+
/**
|
|
2023
|
+
* Charge User Wallet
|
|
2024
|
+
* @schema UserWalletNewChargeReq
|
|
2025
|
+
*/
|
|
2026
|
+
userWalletNewCharge(body: UserWalletNewChargeReq): Promise<import("./types/shared").StdResponse<{
|
|
2027
|
+
wallet: UserWallet;
|
|
2028
|
+
}>>;
|
|
2029
|
+
/**
|
|
2030
|
+
* User Wallet Timeline
|
|
2031
|
+
* @userId number The id of user
|
|
2032
|
+
* @reason string manual,manual_api,invoice,metric
|
|
2033
|
+
* @note string term for search by note
|
|
2034
|
+
* @sortField string Sort,user_id|gmt_create...,Default gmt_create
|
|
2035
|
+
* @sortType string Sort Type,asc|desc,Default desc
|
|
2036
|
+
* @page number Page,Start 0
|
|
2037
|
+
* @count number Count OF Page
|
|
2038
|
+
* @createTimeStart number CreateTimeStart
|
|
2039
|
+
* @createTimeEnd number CreateTimeEnd
|
|
2040
|
+
*/
|
|
2041
|
+
getUserWalletTimeline(params: {
|
|
2042
|
+
userId?: number;
|
|
2043
|
+
reason?: string;
|
|
2044
|
+
note?: string;
|
|
2045
|
+
sortField?: string;
|
|
2046
|
+
sortType?: string;
|
|
2047
|
+
page?: number;
|
|
2048
|
+
count?: number;
|
|
2049
|
+
createTimeStart?: number;
|
|
2050
|
+
createTimeEnd?: number;
|
|
2051
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
2052
|
+
wallet_timeline: UserWalletTimeline[];
|
|
2053
|
+
total: number;
|
|
2054
|
+
}>>;
|
|
2055
|
+
/**
|
|
2056
|
+
* User Wallet Timeline
|
|
2057
|
+
* @schema UserWalletTimelineReq
|
|
2058
|
+
*/
|
|
2059
|
+
userWalletTimeline(body: UserWalletTimelineReq): Promise<import("./types/shared").StdResponse<{
|
|
2060
|
+
wallet_timeline: UserWalletTimeline[];
|
|
2061
|
+
total: number;
|
|
2062
|
+
}>>;
|
|
2063
|
+
/**
|
|
2064
|
+
* Get Vat Country List
|
|
2065
|
+
*/
|
|
2066
|
+
getVatCountryList(): Promise<import("./types/shared").StdResponse<{
|
|
2067
|
+
vatCountryList: VatCountryRate[];
|
|
2068
|
+
}>>;
|
|
2069
|
+
/**
|
|
2070
|
+
* Get Vat Country List
|
|
2071
|
+
* @schema VatCountryListReq
|
|
2072
|
+
*/
|
|
2073
|
+
vatCountryList(body: VatCountryListReq): Promise<import("./types/shared").StdResponse<{
|
|
2074
|
+
vatCountryList: VatCountryRate[];
|
|
2075
|
+
}>>;
|
|
2076
|
+
/**
|
|
2077
|
+
* Init Default Vat Gateway
|
|
2078
|
+
* @schema VatInitDefaultGatewayReq
|
|
2079
|
+
*/
|
|
2080
|
+
vatInitDefaultGateway(body: VatInitDefaultGatewayReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
2081
|
+
/**
|
|
2082
|
+
* Vat Gateway Setup
|
|
2083
|
+
* @schema VatSetupGatewayReq
|
|
2084
|
+
*/
|
|
2085
|
+
vatSetupGateway(body: VatSetupGatewayReq): Promise<import("./types/shared").StdResponse<{
|
|
2086
|
+
data: string;
|
|
2087
|
+
}>>;
|
|
2088
|
+
/**
|
|
2089
|
+
* Vat Number Validation
|
|
2090
|
+
* @schema VatNumberValidateReq
|
|
2091
|
+
*/
|
|
2092
|
+
vatVatNumberValidate(body: VatNumberValidateReq): Promise<import("./types/shared").StdResponse<{
|
|
2093
|
+
vatNumberValidate: ValidResult;
|
|
2094
|
+
}>>;
|
|
2095
|
+
/**
|
|
2096
|
+
* Delete Webhook Endpoint
|
|
2097
|
+
* @schema WebhookDeleteEndpointReq
|
|
2098
|
+
*/
|
|
2099
|
+
webhookDeleteEndpoint(body: WebhookDeleteEndpointReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
2100
|
+
/**
|
|
2101
|
+
* Get Webhook Endpoint list
|
|
2102
|
+
*/
|
|
2103
|
+
getWebhookEndpointList(): Promise<import("./types/shared").StdResponse<{
|
|
2104
|
+
endpointList: MerchantWebhookEndpoint[];
|
|
2105
|
+
}>>;
|
|
2106
|
+
/**
|
|
2107
|
+
* Get Webhook Endpoint Log List
|
|
2108
|
+
* @endpointId number EndpointId
|
|
2109
|
+
* @page number Page, Start With 0
|
|
2110
|
+
* @count number Count Of Page
|
|
2111
|
+
*/
|
|
2112
|
+
getWebhookEndpointLogList(params: {
|
|
2113
|
+
endpointId?: number;
|
|
2114
|
+
page?: number;
|
|
2115
|
+
count?: number;
|
|
2116
|
+
}): Promise<import("./types/shared").StdResponse<{
|
|
2117
|
+
endpointLogList: MerchantWebhookLog[];
|
|
2118
|
+
total: number;
|
|
2119
|
+
}>>;
|
|
2120
|
+
/**
|
|
2121
|
+
* Webhook Event List
|
|
2122
|
+
*/
|
|
2123
|
+
getWebhookEventList(): Promise<import("./types/shared").StdResponse<{
|
|
2124
|
+
eventList: string[];
|
|
2125
|
+
}>>;
|
|
2126
|
+
/**
|
|
2127
|
+
* New Webhook Endpoint
|
|
2128
|
+
* @schema WebhookNewEndpointReq
|
|
2129
|
+
*/
|
|
2130
|
+
webhookNewEndpoint(body: WebhookNewEndpointReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
2131
|
+
/**
|
|
2132
|
+
* Resent Webhook
|
|
2133
|
+
* @schema WebhookResendWebhookReq
|
|
2134
|
+
*/
|
|
2135
|
+
webhookResend(body: WebhookResendWebhookReq): Promise<import("./types/shared").StdResponse<{
|
|
2136
|
+
sendResult: boolean;
|
|
2137
|
+
}>>;
|
|
2138
|
+
/**
|
|
2139
|
+
* Update Webhook Endpoint
|
|
2140
|
+
* @schema WebhookUpdateEndpointReq
|
|
2141
|
+
*/
|
|
2142
|
+
webhookUpdateEndpoint(body: WebhookUpdateEndpointReq): Promise<import("./types/shared").StdResponse<unknown>>;
|
|
2143
|
+
}
|
|
2144
|
+
//# sourceMappingURL=merchant.d.ts.map
|