@inkress/admin-sdk 1.0.0 → 1.1.0
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/CHANGELOG.md +213 -0
- package/README.md +1174 -87
- package/dist/client.d.ts +3 -3
- package/dist/client.d.ts.map +1 -1
- package/dist/data-mappings.d.ts +177 -0
- package/dist/data-mappings.d.ts.map +1 -0
- package/dist/index.d.ts +34 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js +4166 -154
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +4203 -153
- package/dist/index.js.map +1 -1
- package/dist/resources/addresses.d.ts +58 -0
- package/dist/resources/addresses.d.ts.map +1 -0
- package/dist/resources/billing-plans.d.ts +32 -15
- package/dist/resources/billing-plans.d.ts.map +1 -1
- package/dist/resources/categories.d.ts +30 -20
- package/dist/resources/categories.d.ts.map +1 -1
- package/dist/resources/currencies.d.ts +41 -0
- package/dist/resources/currencies.d.ts.map +1 -0
- package/dist/resources/exchange-rates.d.ts +50 -0
- package/dist/resources/exchange-rates.d.ts.map +1 -0
- package/dist/resources/fees.d.ts +58 -0
- package/dist/resources/fees.d.ts.map +1 -0
- package/dist/resources/financial-accounts.d.ts +47 -0
- package/dist/resources/financial-accounts.d.ts.map +1 -0
- package/dist/resources/financial-requests.d.ts +51 -0
- package/dist/resources/financial-requests.d.ts.map +1 -0
- package/dist/resources/generics.d.ts +57 -0
- package/dist/resources/generics.d.ts.map +1 -0
- package/dist/resources/kyc.d.ts +118 -0
- package/dist/resources/kyc.d.ts.map +1 -0
- package/dist/resources/merchants.d.ts +52 -15
- package/dist/resources/merchants.d.ts.map +1 -1
- package/dist/resources/orders.d.ts +74 -2
- package/dist/resources/orders.d.ts.map +1 -1
- package/dist/resources/payment-links.d.ts +65 -0
- package/dist/resources/payment-links.d.ts.map +1 -0
- package/dist/resources/payment-methods.d.ts +48 -0
- package/dist/resources/payment-methods.d.ts.map +1 -0
- package/dist/resources/products.d.ts +62 -16
- package/dist/resources/products.d.ts.map +1 -1
- package/dist/resources/public.d.ts +27 -7
- package/dist/resources/public.d.ts.map +1 -1
- package/dist/resources/subscriptions.d.ts +86 -20
- package/dist/resources/subscriptions.d.ts.map +1 -1
- package/dist/resources/tokens.d.ts +62 -0
- package/dist/resources/tokens.d.ts.map +1 -0
- package/dist/resources/transaction-entries.d.ts +48 -0
- package/dist/resources/transaction-entries.d.ts.map +1 -0
- package/dist/resources/users.d.ts +43 -21
- package/dist/resources/users.d.ts.map +1 -1
- package/dist/resources/webhook-urls.d.ts +49 -0
- package/dist/resources/webhook-urls.d.ts.map +1 -0
- package/dist/types/resources.d.ts +1294 -0
- package/dist/types/resources.d.ts.map +1 -0
- package/dist/types.d.ts +1069 -197
- package/dist/types.d.ts.map +1 -1
- package/dist/utils/query-builders.d.ts +518 -0
- package/dist/utils/query-builders.d.ts.map +1 -0
- package/dist/utils/query-transformer.d.ts +123 -0
- package/dist/utils/query-transformer.d.ts.map +1 -0
- package/dist/utils/translators.d.ts +126 -0
- package/dist/utils/translators.d.ts.map +1 -0
- package/dist/utils/webhooks.d.ts +19 -4
- package/dist/utils/webhooks.d.ts.map +1 -1
- package/package.json +14 -4
|
@@ -0,0 +1,1294 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resource-specific types and interfaces
|
|
3
|
+
*
|
|
4
|
+
* This file contains all filter parameters, list responses, and field type mappings
|
|
5
|
+
* for each resource in the SDK. This provides clear IntelliSense and type safety.
|
|
6
|
+
*/
|
|
7
|
+
import type { BaseFilterParams, Order, OrderStatus, OrderKind, Product, ProductStatus, User, AccountStatus, UserKind, Merchant, Category, CategoryKind, BillingPlan, BillingPlanKind, Subscription, SubscriptionStatus, PaymentLink, FinancialAccount, FinancialRequest, WebhookUrl, Token, Address, Currency, ExchangeRate, Fee, PaymentMethod, TransactionEntry } from '../types';
|
|
8
|
+
import type { StatusKey, KindKey, FeeStructureKey } from '../utils/translators';
|
|
9
|
+
import type { RangeQuery, StringQuery, DateQuery } from '../utils/query-transformer';
|
|
10
|
+
/**
|
|
11
|
+
* Order field types - defines what operations are available on each field
|
|
12
|
+
*/
|
|
13
|
+
export declare const ORDER_FIELD_TYPES: {
|
|
14
|
+
readonly id: "number";
|
|
15
|
+
readonly reference_id: "string";
|
|
16
|
+
readonly total: "number";
|
|
17
|
+
readonly status: "number";
|
|
18
|
+
readonly kind: "number";
|
|
19
|
+
readonly status_on: "number";
|
|
20
|
+
readonly uid: "string";
|
|
21
|
+
readonly cart_id: "number";
|
|
22
|
+
readonly currency_id: "number";
|
|
23
|
+
readonly customer_id: "number";
|
|
24
|
+
readonly payment_link_id: "number";
|
|
25
|
+
readonly billing_plan_id: "number";
|
|
26
|
+
readonly session_id: "string";
|
|
27
|
+
readonly inserted_at: "date";
|
|
28
|
+
readonly updated_at: "date";
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Product field types
|
|
32
|
+
*/
|
|
33
|
+
export declare const PRODUCT_FIELD_TYPES: {
|
|
34
|
+
readonly id: "number";
|
|
35
|
+
readonly title: "string";
|
|
36
|
+
readonly teaser: "string";
|
|
37
|
+
readonly price: "number";
|
|
38
|
+
readonly permalink: "string";
|
|
39
|
+
readonly image: "string";
|
|
40
|
+
readonly status: "number";
|
|
41
|
+
readonly public: "boolean";
|
|
42
|
+
readonly unlimited: "boolean";
|
|
43
|
+
readonly units_remaining: "number";
|
|
44
|
+
readonly units_sold: "number";
|
|
45
|
+
readonly rating_sum: "number";
|
|
46
|
+
readonly rating_count: "number";
|
|
47
|
+
readonly tag_ids: "array";
|
|
48
|
+
readonly uid: "string";
|
|
49
|
+
readonly category_id: "number";
|
|
50
|
+
readonly currency_id: "number";
|
|
51
|
+
readonly user_id: "number";
|
|
52
|
+
readonly inserted_at: "date";
|
|
53
|
+
readonly updated_at: "date";
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* User field types
|
|
57
|
+
*/
|
|
58
|
+
export declare const USER_FIELD_TYPES: {
|
|
59
|
+
readonly id: "number";
|
|
60
|
+
readonly email: "string";
|
|
61
|
+
readonly phone: "string";
|
|
62
|
+
readonly first_name: "string";
|
|
63
|
+
readonly last_name: "string";
|
|
64
|
+
readonly username: "string";
|
|
65
|
+
readonly status: "number";
|
|
66
|
+
readonly kind: "number";
|
|
67
|
+
readonly level: "number";
|
|
68
|
+
readonly dob: "number";
|
|
69
|
+
readonly sex: "number";
|
|
70
|
+
readonly image: "string";
|
|
71
|
+
readonly uid: "string";
|
|
72
|
+
readonly organisation_id: "number";
|
|
73
|
+
readonly role_id: "number";
|
|
74
|
+
readonly inserted_at: "date";
|
|
75
|
+
readonly updated_at: "date";
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* Merchant field types
|
|
79
|
+
*/
|
|
80
|
+
export declare const MERCHANT_FIELD_TYPES: {
|
|
81
|
+
readonly id: "number";
|
|
82
|
+
readonly name: "string";
|
|
83
|
+
readonly email: "string";
|
|
84
|
+
readonly username: "string";
|
|
85
|
+
readonly about: "string";
|
|
86
|
+
readonly logo: "string";
|
|
87
|
+
readonly sector: "string";
|
|
88
|
+
readonly status: "number";
|
|
89
|
+
readonly phone: "string";
|
|
90
|
+
readonly business_type: "string";
|
|
91
|
+
readonly theme_colour: "string";
|
|
92
|
+
readonly uid: "string";
|
|
93
|
+
readonly address_id: "number";
|
|
94
|
+
readonly owner_id: "number";
|
|
95
|
+
readonly domain_id: "number";
|
|
96
|
+
readonly organisation_id: "number";
|
|
97
|
+
readonly platform_fee_structure: "number";
|
|
98
|
+
readonly provider_fee_structure: "number";
|
|
99
|
+
readonly parent_merchant_id: "number";
|
|
100
|
+
readonly inserted_at: "date";
|
|
101
|
+
readonly updated_at: "date";
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* Category field types
|
|
105
|
+
*/
|
|
106
|
+
export declare const CATEGORY_FIELD_TYPES: {
|
|
107
|
+
readonly id: "number";
|
|
108
|
+
readonly name: "string";
|
|
109
|
+
readonly description: "string";
|
|
110
|
+
readonly kind: "number";
|
|
111
|
+
readonly kind_id: "number";
|
|
112
|
+
readonly parent_id: "number";
|
|
113
|
+
readonly uid: "string";
|
|
114
|
+
readonly inserted_at: "date";
|
|
115
|
+
readonly updated_at: "date";
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* Billing Plan field types
|
|
119
|
+
*/
|
|
120
|
+
export declare const BILLING_PLAN_FIELD_TYPES: {
|
|
121
|
+
readonly id: "number";
|
|
122
|
+
readonly name: "string";
|
|
123
|
+
readonly description: "string";
|
|
124
|
+
readonly flat_rate: "number";
|
|
125
|
+
readonly transaction_fee: "number";
|
|
126
|
+
readonly transaction_percentage: "number";
|
|
127
|
+
readonly transaction_percentage_additional: "number";
|
|
128
|
+
readonly transaction_minimum_fee: "number";
|
|
129
|
+
readonly minimum_fee: "number";
|
|
130
|
+
readonly duration: "number";
|
|
131
|
+
readonly status: "number";
|
|
132
|
+
readonly kind: "number";
|
|
133
|
+
readonly billing_cycle: "number";
|
|
134
|
+
readonly trial_period: "number";
|
|
135
|
+
readonly charge_strategy: "number";
|
|
136
|
+
readonly auto_charge: "boolean";
|
|
137
|
+
readonly public: "boolean";
|
|
138
|
+
readonly payout_period: "number";
|
|
139
|
+
readonly payout_value_limit: "number";
|
|
140
|
+
readonly payout_percentage_limit: "number";
|
|
141
|
+
readonly uid: "string";
|
|
142
|
+
readonly currency_id: "number";
|
|
143
|
+
readonly payment_provider_id: "number";
|
|
144
|
+
readonly inserted_at: "date";
|
|
145
|
+
readonly updated_at: "date";
|
|
146
|
+
};
|
|
147
|
+
/**
|
|
148
|
+
* Subscription field types
|
|
149
|
+
*/
|
|
150
|
+
export declare const SUBSCRIPTION_FIELD_TYPES: {
|
|
151
|
+
readonly id: "number";
|
|
152
|
+
readonly status: "number";
|
|
153
|
+
readonly kind: "number";
|
|
154
|
+
readonly record_id: "number";
|
|
155
|
+
readonly record: "string";
|
|
156
|
+
readonly start_date: "date";
|
|
157
|
+
readonly end_date: "date";
|
|
158
|
+
readonly current_period_start: "date";
|
|
159
|
+
readonly current_period_end: "date";
|
|
160
|
+
readonly trial_end: "date";
|
|
161
|
+
readonly canceled_at: "date";
|
|
162
|
+
readonly uid: "string";
|
|
163
|
+
readonly token: "string";
|
|
164
|
+
readonly billing_plan_id: "number";
|
|
165
|
+
readonly customer_id: "number";
|
|
166
|
+
readonly inserted_at: "date";
|
|
167
|
+
readonly updated_at: "date";
|
|
168
|
+
};
|
|
169
|
+
/**
|
|
170
|
+
* Payment Link field types
|
|
171
|
+
*/
|
|
172
|
+
export declare const PAYMENT_LINK_FIELD_TYPES: {
|
|
173
|
+
readonly id: "number";
|
|
174
|
+
readonly uid: "string";
|
|
175
|
+
readonly title: "string";
|
|
176
|
+
readonly description: "string";
|
|
177
|
+
readonly total: "number";
|
|
178
|
+
readonly usage_limit: "number";
|
|
179
|
+
readonly expires_at: "date";
|
|
180
|
+
readonly status: "number";
|
|
181
|
+
readonly kind: "number";
|
|
182
|
+
readonly customer_id: "number";
|
|
183
|
+
readonly currency_id: "number";
|
|
184
|
+
readonly order_id: "number";
|
|
185
|
+
readonly inserted_at: "date";
|
|
186
|
+
readonly updated_at: "date";
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Financial Account field types
|
|
190
|
+
*/
|
|
191
|
+
export declare const FINANCIAL_ACCOUNT_FIELD_TYPES: {
|
|
192
|
+
readonly id: "number";
|
|
193
|
+
readonly name: "string";
|
|
194
|
+
readonly type: "string";
|
|
195
|
+
readonly provider: "string";
|
|
196
|
+
readonly is_external: "boolean";
|
|
197
|
+
readonly fingerprint: "string";
|
|
198
|
+
readonly record: "string";
|
|
199
|
+
readonly record_id: "number";
|
|
200
|
+
readonly active: "boolean";
|
|
201
|
+
readonly code: "string";
|
|
202
|
+
readonly adapter: "string";
|
|
203
|
+
readonly logo: "string";
|
|
204
|
+
readonly website: "string";
|
|
205
|
+
readonly inserted_at: "date";
|
|
206
|
+
readonly updated_at: "date";
|
|
207
|
+
};
|
|
208
|
+
/**
|
|
209
|
+
* Financial Request field types
|
|
210
|
+
*/
|
|
211
|
+
export declare const FINANCIAL_REQUEST_FIELD_TYPES: {
|
|
212
|
+
readonly id: "number";
|
|
213
|
+
readonly total: "number";
|
|
214
|
+
readonly status: "number";
|
|
215
|
+
readonly type: "number";
|
|
216
|
+
readonly sub_type: "number";
|
|
217
|
+
readonly fee_total: "number";
|
|
218
|
+
readonly reference_id: "string";
|
|
219
|
+
readonly reviewed_at: "date";
|
|
220
|
+
readonly due_at: "date";
|
|
221
|
+
readonly balance_on_request: "number";
|
|
222
|
+
readonly source_id: "number";
|
|
223
|
+
readonly destination_id: "number";
|
|
224
|
+
readonly merchant_id: "number";
|
|
225
|
+
readonly requester_id: "number";
|
|
226
|
+
readonly reviewer_id: "number";
|
|
227
|
+
readonly currency_id: "number";
|
|
228
|
+
readonly evidence_file_id: "number";
|
|
229
|
+
readonly inserted_at: "date";
|
|
230
|
+
readonly updated_at: "date";
|
|
231
|
+
};
|
|
232
|
+
/**
|
|
233
|
+
* Webhook URL field types
|
|
234
|
+
*/
|
|
235
|
+
export declare const WEBHOOK_URL_FIELD_TYPES: {
|
|
236
|
+
readonly id: "number";
|
|
237
|
+
readonly url: "string";
|
|
238
|
+
readonly event: "string";
|
|
239
|
+
readonly uid: "string";
|
|
240
|
+
readonly merchant_id: "number";
|
|
241
|
+
readonly org_id: "number";
|
|
242
|
+
readonly inserted_at: "date";
|
|
243
|
+
readonly updated_at: "date";
|
|
244
|
+
};
|
|
245
|
+
/**
|
|
246
|
+
* Token field types
|
|
247
|
+
*/
|
|
248
|
+
export declare const TOKEN_FIELD_TYPES: {
|
|
249
|
+
readonly id: "number";
|
|
250
|
+
readonly public_key: "string";
|
|
251
|
+
readonly title: "string";
|
|
252
|
+
readonly provider: "string";
|
|
253
|
+
readonly kind: "number";
|
|
254
|
+
readonly enabled: "boolean";
|
|
255
|
+
readonly expires: "number";
|
|
256
|
+
readonly user_id: "number";
|
|
257
|
+
readonly role_id: "number";
|
|
258
|
+
readonly inserted_at: "date";
|
|
259
|
+
readonly updated_at: "date";
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* Address field types
|
|
263
|
+
*/
|
|
264
|
+
export declare const ADDRESS_FIELD_TYPES: {
|
|
265
|
+
readonly id: "number";
|
|
266
|
+
readonly hash: "string";
|
|
267
|
+
readonly kind: "number";
|
|
268
|
+
readonly kind_id: "number";
|
|
269
|
+
readonly lang: "number";
|
|
270
|
+
readonly lat: "number";
|
|
271
|
+
readonly street: "string";
|
|
272
|
+
readonly street_optional: "string";
|
|
273
|
+
readonly city: "string";
|
|
274
|
+
readonly state: "string";
|
|
275
|
+
readonly country: "string";
|
|
276
|
+
readonly region: "string";
|
|
277
|
+
readonly town: "string";
|
|
278
|
+
readonly inserted_at: "date";
|
|
279
|
+
readonly updated_at: "date";
|
|
280
|
+
};
|
|
281
|
+
/**
|
|
282
|
+
* Currency field types
|
|
283
|
+
*/
|
|
284
|
+
export declare const CURRENCY_FIELD_TYPES: {
|
|
285
|
+
readonly id: "number";
|
|
286
|
+
readonly code: "string";
|
|
287
|
+
readonly flag: "string";
|
|
288
|
+
readonly is_float: "boolean";
|
|
289
|
+
readonly inserted_at: "date";
|
|
290
|
+
readonly updated_at: "date";
|
|
291
|
+
};
|
|
292
|
+
/**
|
|
293
|
+
* Exchange Rate field types
|
|
294
|
+
*/
|
|
295
|
+
export declare const EXCHANGE_RATE_FIELD_TYPES: {
|
|
296
|
+
readonly id: "number";
|
|
297
|
+
readonly source_id: "number";
|
|
298
|
+
readonly destination_id: "number";
|
|
299
|
+
readonly rate: "number";
|
|
300
|
+
readonly expires: "number";
|
|
301
|
+
readonly source: "string";
|
|
302
|
+
readonly user_id: "number";
|
|
303
|
+
readonly inserted_at: "date";
|
|
304
|
+
readonly updated_at: "date";
|
|
305
|
+
};
|
|
306
|
+
/**
|
|
307
|
+
* Fee field types
|
|
308
|
+
*/
|
|
309
|
+
export declare const FEE_FIELD_TYPES: {
|
|
310
|
+
readonly id: "number";
|
|
311
|
+
readonly title: "string";
|
|
312
|
+
readonly total: "number";
|
|
313
|
+
readonly unit: "number";
|
|
314
|
+
readonly kind: "number";
|
|
315
|
+
readonly priority: "number";
|
|
316
|
+
readonly compound: "boolean";
|
|
317
|
+
readonly fee_payer: "number";
|
|
318
|
+
readonly currency_code: "string";
|
|
319
|
+
readonly hash: "string";
|
|
320
|
+
readonly fee_set_id: "number";
|
|
321
|
+
readonly currency_id: "number";
|
|
322
|
+
readonly user_id: "number";
|
|
323
|
+
readonly inserted_at: "date";
|
|
324
|
+
readonly updated_at: "date";
|
|
325
|
+
};
|
|
326
|
+
/**
|
|
327
|
+
* Payment Method field types
|
|
328
|
+
*/
|
|
329
|
+
export declare const PAYMENT_METHOD_FIELD_TYPES: {
|
|
330
|
+
readonly id: "number";
|
|
331
|
+
readonly name: "string";
|
|
332
|
+
readonly code: "string";
|
|
333
|
+
readonly provider: "string";
|
|
334
|
+
readonly active: "boolean";
|
|
335
|
+
readonly payment_provider_id: "number";
|
|
336
|
+
readonly financial_account_id: "number";
|
|
337
|
+
readonly inserted_at: "date";
|
|
338
|
+
readonly updated_at: "date";
|
|
339
|
+
};
|
|
340
|
+
/**
|
|
341
|
+
* Transaction Entry field types
|
|
342
|
+
*/
|
|
343
|
+
export declare const TRANSACTION_ENTRY_FIELD_TYPES: {
|
|
344
|
+
readonly id: "number";
|
|
345
|
+
readonly amount: "number";
|
|
346
|
+
readonly type: "number";
|
|
347
|
+
readonly transaction_id: "number";
|
|
348
|
+
readonly financial_account_id: "number";
|
|
349
|
+
readonly inserted_at: "date";
|
|
350
|
+
readonly updated_at: "date";
|
|
351
|
+
};
|
|
352
|
+
/**
|
|
353
|
+
* Order query parameters with full type safety
|
|
354
|
+
* Supports direct values, arrays (IN), ranges, and string operations
|
|
355
|
+
*/
|
|
356
|
+
export interface OrderQueryParams {
|
|
357
|
+
id?: number | number[] | RangeQuery<number>;
|
|
358
|
+
total?: number | number[] | RangeQuery<number>;
|
|
359
|
+
status_on?: number | number[] | RangeQuery<number>;
|
|
360
|
+
cart_id?: number | number[];
|
|
361
|
+
currency_id?: number | number[];
|
|
362
|
+
customer_id?: number | number[];
|
|
363
|
+
payment_link_id?: number | number[];
|
|
364
|
+
billing_plan_id?: number | number[];
|
|
365
|
+
billing_subscription_id?: number | number[];
|
|
366
|
+
reference_id?: string | string[] | StringQuery;
|
|
367
|
+
uid?: string | string[] | StringQuery;
|
|
368
|
+
session_id?: string | string[] | StringQuery;
|
|
369
|
+
status?: OrderStatus | OrderStatus[] | StatusKey | number | number[];
|
|
370
|
+
kind?: OrderKind | OrderKind[] | KindKey | number | number[];
|
|
371
|
+
inserted_at?: string | DateQuery;
|
|
372
|
+
updated_at?: string | DateQuery;
|
|
373
|
+
data?: any;
|
|
374
|
+
exclude?: string | number;
|
|
375
|
+
distinct?: string;
|
|
376
|
+
order_by?: string;
|
|
377
|
+
page?: number;
|
|
378
|
+
page_size?: number;
|
|
379
|
+
per_page?: number;
|
|
380
|
+
limit?: number;
|
|
381
|
+
override_page?: string | boolean;
|
|
382
|
+
q?: string;
|
|
383
|
+
search?: string;
|
|
384
|
+
sort?: string;
|
|
385
|
+
order?: 'asc' | 'desc';
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* Product query parameters with full type safety
|
|
389
|
+
*/
|
|
390
|
+
export interface ProductQueryParams {
|
|
391
|
+
id?: number | number[] | RangeQuery<number>;
|
|
392
|
+
price?: number | number[] | RangeQuery<number>;
|
|
393
|
+
units_remaining?: number | number[] | RangeQuery<number>;
|
|
394
|
+
units_sold?: number | number[] | RangeQuery<number>;
|
|
395
|
+
rating_sum?: number | number[] | RangeQuery<number>;
|
|
396
|
+
rating_count?: number | number[] | RangeQuery<number>;
|
|
397
|
+
category_id?: number | number[];
|
|
398
|
+
currency_id?: number | number[];
|
|
399
|
+
user_id?: number | number[];
|
|
400
|
+
title?: string | string[] | StringQuery;
|
|
401
|
+
teaser?: string | string[] | StringQuery;
|
|
402
|
+
permalink?: string | string[] | StringQuery;
|
|
403
|
+
image?: string | string[] | StringQuery;
|
|
404
|
+
uid?: string | string[] | StringQuery;
|
|
405
|
+
status?: ProductStatus | ProductStatus[] | StatusKey | number | number[];
|
|
406
|
+
public?: boolean;
|
|
407
|
+
unlimited?: boolean;
|
|
408
|
+
tag_ids?: number[];
|
|
409
|
+
inserted_at?: string | DateQuery;
|
|
410
|
+
updated_at?: string | DateQuery;
|
|
411
|
+
exclude?: string | number;
|
|
412
|
+
distinct?: string;
|
|
413
|
+
order_by?: string;
|
|
414
|
+
page?: number;
|
|
415
|
+
page_size?: number;
|
|
416
|
+
per_page?: number;
|
|
417
|
+
limit?: number;
|
|
418
|
+
override_page?: string | boolean;
|
|
419
|
+
q?: string;
|
|
420
|
+
search?: string;
|
|
421
|
+
sort?: string;
|
|
422
|
+
order?: 'asc' | 'desc';
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* User query parameters with full type safety
|
|
426
|
+
*/
|
|
427
|
+
export interface UserQueryParams {
|
|
428
|
+
id?: number | number[] | RangeQuery<number>;
|
|
429
|
+
level?: number | number[] | RangeQuery<number>;
|
|
430
|
+
dob?: number | number[] | RangeQuery<number>;
|
|
431
|
+
sex?: number | number[];
|
|
432
|
+
organisation_id?: number | number[];
|
|
433
|
+
role_id?: number | number[];
|
|
434
|
+
email?: string | string[] | StringQuery;
|
|
435
|
+
phone?: string | string[] | StringQuery;
|
|
436
|
+
first_name?: string | string[] | StringQuery;
|
|
437
|
+
last_name?: string | string[] | StringQuery;
|
|
438
|
+
username?: string | string[] | StringQuery;
|
|
439
|
+
image?: string | string[] | StringQuery;
|
|
440
|
+
uid?: string | string[] | StringQuery;
|
|
441
|
+
status?: AccountStatus | AccountStatus[] | StatusKey | number | number[];
|
|
442
|
+
kind?: UserKind | UserKind[] | KindKey | number | number[];
|
|
443
|
+
inserted_at?: string | DateQuery;
|
|
444
|
+
updated_at?: string | DateQuery;
|
|
445
|
+
exclude?: string | number;
|
|
446
|
+
distinct?: string;
|
|
447
|
+
order_by?: string;
|
|
448
|
+
page?: number;
|
|
449
|
+
page_size?: number;
|
|
450
|
+
per_page?: number;
|
|
451
|
+
limit?: number;
|
|
452
|
+
override_page?: string | boolean;
|
|
453
|
+
q?: string;
|
|
454
|
+
search?: string;
|
|
455
|
+
sort?: string;
|
|
456
|
+
order?: 'asc' | 'desc';
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* Merchant query parameters with full type safety
|
|
460
|
+
*/
|
|
461
|
+
export interface MerchantQueryParams {
|
|
462
|
+
id?: number | number[] | RangeQuery<number>;
|
|
463
|
+
address_id?: number | number[];
|
|
464
|
+
owner_id?: number | number[];
|
|
465
|
+
domain_id?: number | number[];
|
|
466
|
+
organisation_id?: number | number[];
|
|
467
|
+
parent_merchant_id?: number | number[];
|
|
468
|
+
platform_fee_structure?: FeeStructureKey | number | number[];
|
|
469
|
+
provider_fee_structure?: FeeStructureKey | number | number[];
|
|
470
|
+
name?: string | string[] | StringQuery;
|
|
471
|
+
email?: string | string[] | StringQuery;
|
|
472
|
+
username?: string | string[] | StringQuery;
|
|
473
|
+
about?: string | string[] | StringQuery;
|
|
474
|
+
logo?: string | string[] | StringQuery;
|
|
475
|
+
sector?: string | string[] | StringQuery;
|
|
476
|
+
phone?: string | string[] | StringQuery;
|
|
477
|
+
business_type?: string | string[] | StringQuery;
|
|
478
|
+
theme_colour?: string | string[] | StringQuery;
|
|
479
|
+
uid?: string | string[] | StringQuery;
|
|
480
|
+
status?: AccountStatus | AccountStatus[] | StatusKey | number | number[];
|
|
481
|
+
inserted_at?: string | DateQuery;
|
|
482
|
+
updated_at?: string | DateQuery;
|
|
483
|
+
exclude?: string | number;
|
|
484
|
+
distinct?: string;
|
|
485
|
+
order_by?: string;
|
|
486
|
+
page?: number;
|
|
487
|
+
page_size?: number;
|
|
488
|
+
per_page?: number;
|
|
489
|
+
limit?: number;
|
|
490
|
+
override_page?: string | boolean;
|
|
491
|
+
q?: string;
|
|
492
|
+
search?: string;
|
|
493
|
+
sort?: string;
|
|
494
|
+
order?: 'asc' | 'desc';
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* Category query parameters with full type safety
|
|
498
|
+
*/
|
|
499
|
+
export interface CategoryQueryParams {
|
|
500
|
+
id?: number | number[] | RangeQuery<number>;
|
|
501
|
+
kind_id?: number | number[];
|
|
502
|
+
parent_id?: number | number[];
|
|
503
|
+
name?: string | string[] | StringQuery;
|
|
504
|
+
description?: string | string[] | StringQuery;
|
|
505
|
+
uid?: string | string[] | StringQuery;
|
|
506
|
+
kind?: CategoryKind | CategoryKind[] | KindKey | number | number[];
|
|
507
|
+
inserted_at?: string | DateQuery;
|
|
508
|
+
updated_at?: string | DateQuery;
|
|
509
|
+
exclude?: string | number;
|
|
510
|
+
distinct?: string;
|
|
511
|
+
order_by?: string;
|
|
512
|
+
page?: number;
|
|
513
|
+
page_size?: number;
|
|
514
|
+
per_page?: number;
|
|
515
|
+
limit?: number;
|
|
516
|
+
override_page?: string | boolean;
|
|
517
|
+
q?: string;
|
|
518
|
+
search?: string;
|
|
519
|
+
sort?: string;
|
|
520
|
+
order?: 'asc' | 'desc';
|
|
521
|
+
}
|
|
522
|
+
/**
|
|
523
|
+
* Billing Plan query parameters with full type safety
|
|
524
|
+
*/
|
|
525
|
+
export interface BillingPlanQueryParams {
|
|
526
|
+
id?: number | number[] | RangeQuery<number>;
|
|
527
|
+
flat_rate?: number | number[] | RangeQuery<number>;
|
|
528
|
+
transaction_fee?: number | number[] | RangeQuery<number>;
|
|
529
|
+
transaction_percentage?: number | number[] | RangeQuery<number>;
|
|
530
|
+
transaction_percentage_additional?: number | number[] | RangeQuery<number>;
|
|
531
|
+
transaction_minimum_fee?: number | number[] | RangeQuery<number>;
|
|
532
|
+
minimum_fee?: number | number[] | RangeQuery<number>;
|
|
533
|
+
duration?: number | number[] | RangeQuery<number>;
|
|
534
|
+
billing_cycle?: number | number[] | RangeQuery<number>;
|
|
535
|
+
trial_period?: number | number[] | RangeQuery<number>;
|
|
536
|
+
charge_strategy?: number | number[];
|
|
537
|
+
payout_period?: number | number[] | RangeQuery<number>;
|
|
538
|
+
payout_value_limit?: number | number[] | RangeQuery<number>;
|
|
539
|
+
payout_percentage_limit?: number | number[] | RangeQuery<number>;
|
|
540
|
+
currency_id?: number | number[];
|
|
541
|
+
payment_provider_id?: number | number[];
|
|
542
|
+
name?: string | string[] | StringQuery;
|
|
543
|
+
description?: string | string[] | StringQuery;
|
|
544
|
+
uid?: string | string[] | StringQuery;
|
|
545
|
+
status?: StatusKey | number | number[];
|
|
546
|
+
kind?: BillingPlanKind | BillingPlanKind[] | KindKey | number | number[];
|
|
547
|
+
auto_charge?: boolean;
|
|
548
|
+
public?: boolean;
|
|
549
|
+
inserted_at?: string | DateQuery;
|
|
550
|
+
updated_at?: string | DateQuery;
|
|
551
|
+
exclude?: string | number;
|
|
552
|
+
distinct?: string;
|
|
553
|
+
order_by?: string;
|
|
554
|
+
page?: number;
|
|
555
|
+
page_size?: number;
|
|
556
|
+
per_page?: number;
|
|
557
|
+
limit?: number;
|
|
558
|
+
override_page?: string | boolean;
|
|
559
|
+
q?: string;
|
|
560
|
+
search?: string;
|
|
561
|
+
sort?: string;
|
|
562
|
+
order?: 'asc' | 'desc';
|
|
563
|
+
}
|
|
564
|
+
/**
|
|
565
|
+
* Subscription query parameters with full type safety
|
|
566
|
+
*/
|
|
567
|
+
export interface SubscriptionQueryParams {
|
|
568
|
+
id?: number | number[] | RangeQuery<number>;
|
|
569
|
+
record_id?: number | number[] | RangeQuery<number>;
|
|
570
|
+
billing_plan_id?: number | number[];
|
|
571
|
+
customer_id?: number | number[];
|
|
572
|
+
order_id?: number | number[];
|
|
573
|
+
record?: string | string[] | StringQuery;
|
|
574
|
+
uid?: string | string[] | StringQuery;
|
|
575
|
+
token?: string | string[] | StringQuery;
|
|
576
|
+
status?: SubscriptionStatus | SubscriptionStatus[] | StatusKey | number | number[];
|
|
577
|
+
kind?: KindKey | number | number[];
|
|
578
|
+
start_date?: string | DateQuery;
|
|
579
|
+
end_date?: string | DateQuery;
|
|
580
|
+
current_period_start?: string | DateQuery;
|
|
581
|
+
current_period_end?: string | DateQuery;
|
|
582
|
+
trial_end?: string | DateQuery;
|
|
583
|
+
canceled_at?: string | DateQuery;
|
|
584
|
+
inserted_at?: string | DateQuery;
|
|
585
|
+
updated_at?: string | DateQuery;
|
|
586
|
+
exclude?: string | number;
|
|
587
|
+
distinct?: string;
|
|
588
|
+
order_by?: string;
|
|
589
|
+
page?: number;
|
|
590
|
+
page_size?: number;
|
|
591
|
+
per_page?: number;
|
|
592
|
+
limit?: number;
|
|
593
|
+
override_page?: string | boolean;
|
|
594
|
+
q?: string;
|
|
595
|
+
search?: string;
|
|
596
|
+
sort?: string;
|
|
597
|
+
order?: 'asc' | 'desc';
|
|
598
|
+
}
|
|
599
|
+
/**
|
|
600
|
+
* Payment Link query parameters with full type safety
|
|
601
|
+
*/
|
|
602
|
+
export interface PaymentLinkQueryParams {
|
|
603
|
+
id?: number | number[] | RangeQuery<number>;
|
|
604
|
+
total?: number | number[] | RangeQuery<number>;
|
|
605
|
+
usage_limit?: number | number[] | RangeQuery<number>;
|
|
606
|
+
status?: number | number[];
|
|
607
|
+
kind?: number | number[];
|
|
608
|
+
customer_id?: number | number[];
|
|
609
|
+
currency_id?: number | number[];
|
|
610
|
+
order_id?: number | number[];
|
|
611
|
+
uid?: string | string[] | StringQuery;
|
|
612
|
+
title?: string | string[] | StringQuery;
|
|
613
|
+
description?: string | string[] | StringQuery;
|
|
614
|
+
expires_at?: string | DateQuery;
|
|
615
|
+
inserted_at?: string | DateQuery;
|
|
616
|
+
updated_at?: string | DateQuery;
|
|
617
|
+
exclude?: string | number;
|
|
618
|
+
distinct?: string;
|
|
619
|
+
order_by?: string;
|
|
620
|
+
page?: number;
|
|
621
|
+
page_size?: number;
|
|
622
|
+
per_page?: number;
|
|
623
|
+
limit?: number;
|
|
624
|
+
override_page?: string | boolean;
|
|
625
|
+
q?: string;
|
|
626
|
+
search?: string;
|
|
627
|
+
sort?: string;
|
|
628
|
+
order?: 'asc' | 'desc';
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
* Financial Account query parameters with full type safety
|
|
632
|
+
*/
|
|
633
|
+
export interface FinancialAccountQueryParams {
|
|
634
|
+
id?: number | number[] | RangeQuery<number>;
|
|
635
|
+
record_id?: number | number[];
|
|
636
|
+
name?: string | string[] | StringQuery;
|
|
637
|
+
type?: string | string[] | StringQuery;
|
|
638
|
+
provider?: string | string[] | StringQuery;
|
|
639
|
+
fingerprint?: string | string[] | StringQuery;
|
|
640
|
+
record?: string | string[] | StringQuery;
|
|
641
|
+
code?: string | string[] | StringQuery;
|
|
642
|
+
adapter?: string | string[] | StringQuery;
|
|
643
|
+
logo?: string | string[] | StringQuery;
|
|
644
|
+
website?: string | string[] | StringQuery;
|
|
645
|
+
is_external?: boolean;
|
|
646
|
+
active?: boolean;
|
|
647
|
+
inserted_at?: string | DateQuery;
|
|
648
|
+
updated_at?: string | DateQuery;
|
|
649
|
+
exclude?: string | number;
|
|
650
|
+
distinct?: string;
|
|
651
|
+
order_by?: string;
|
|
652
|
+
page?: number;
|
|
653
|
+
page_size?: number;
|
|
654
|
+
per_page?: number;
|
|
655
|
+
limit?: number;
|
|
656
|
+
override_page?: string | boolean;
|
|
657
|
+
q?: string;
|
|
658
|
+
search?: string;
|
|
659
|
+
sort?: string;
|
|
660
|
+
order?: 'asc' | 'desc';
|
|
661
|
+
}
|
|
662
|
+
/**
|
|
663
|
+
* Financial Request query parameters with full type safety
|
|
664
|
+
*/
|
|
665
|
+
export interface FinancialRequestQueryParams {
|
|
666
|
+
id?: number | number[] | RangeQuery<number>;
|
|
667
|
+
total?: number | number[] | RangeQuery<number>;
|
|
668
|
+
status?: number | number[];
|
|
669
|
+
type?: number | number[];
|
|
670
|
+
sub_type?: number | number[];
|
|
671
|
+
fee_total?: number | number[] | RangeQuery<number>;
|
|
672
|
+
balance_on_request?: number | number[] | RangeQuery<number>;
|
|
673
|
+
source_id?: number | number[];
|
|
674
|
+
destination_id?: number | number[];
|
|
675
|
+
merchant_id?: number | number[];
|
|
676
|
+
requester_id?: number | number[];
|
|
677
|
+
reviewer_id?: number | number[];
|
|
678
|
+
currency_id?: number | number[];
|
|
679
|
+
evidence_file_id?: number | number[];
|
|
680
|
+
reference_id?: string | string[] | StringQuery;
|
|
681
|
+
reviewed_at?: string | DateQuery;
|
|
682
|
+
due_at?: string | DateQuery;
|
|
683
|
+
inserted_at?: string | DateQuery;
|
|
684
|
+
updated_at?: string | DateQuery;
|
|
685
|
+
exclude?: string | number;
|
|
686
|
+
distinct?: string;
|
|
687
|
+
order_by?: string;
|
|
688
|
+
page?: number;
|
|
689
|
+
page_size?: number;
|
|
690
|
+
per_page?: number;
|
|
691
|
+
limit?: number;
|
|
692
|
+
override_page?: string | boolean;
|
|
693
|
+
q?: string;
|
|
694
|
+
search?: string;
|
|
695
|
+
sort?: string;
|
|
696
|
+
order?: 'asc' | 'desc';
|
|
697
|
+
}
|
|
698
|
+
/**
|
|
699
|
+
* Webhook URL query parameters with full type safety
|
|
700
|
+
*/
|
|
701
|
+
export interface WebhookUrlQueryParams {
|
|
702
|
+
id?: number | number[] | RangeQuery<number>;
|
|
703
|
+
merchant_id?: number | number[];
|
|
704
|
+
org_id?: number | number[];
|
|
705
|
+
url?: string | string[] | StringQuery;
|
|
706
|
+
event?: string | string[] | StringQuery;
|
|
707
|
+
uid?: string | string[] | StringQuery;
|
|
708
|
+
inserted_at?: string | DateQuery;
|
|
709
|
+
updated_at?: string | DateQuery;
|
|
710
|
+
exclude?: string | number;
|
|
711
|
+
distinct?: string;
|
|
712
|
+
order_by?: string;
|
|
713
|
+
page?: number;
|
|
714
|
+
page_size?: number;
|
|
715
|
+
per_page?: number;
|
|
716
|
+
limit?: number;
|
|
717
|
+
override_page?: string | boolean;
|
|
718
|
+
q?: string;
|
|
719
|
+
search?: string;
|
|
720
|
+
sort?: string;
|
|
721
|
+
order?: 'asc' | 'desc';
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
* Token query parameters with full type safety
|
|
725
|
+
*/
|
|
726
|
+
export interface TokenQueryParams {
|
|
727
|
+
id?: number | number[] | RangeQuery<number>;
|
|
728
|
+
kind?: number | number[];
|
|
729
|
+
expires?: number | number[] | RangeQuery<number>;
|
|
730
|
+
user_id?: number | number[];
|
|
731
|
+
role_id?: number | number[];
|
|
732
|
+
public_key?: string | string[] | StringQuery;
|
|
733
|
+
title?: string | string[] | StringQuery;
|
|
734
|
+
provider?: string | string[] | StringQuery;
|
|
735
|
+
enabled?: boolean;
|
|
736
|
+
inserted_at?: string | DateQuery;
|
|
737
|
+
updated_at?: string | DateQuery;
|
|
738
|
+
exclude?: string | number;
|
|
739
|
+
distinct?: string;
|
|
740
|
+
order_by?: string;
|
|
741
|
+
page?: number;
|
|
742
|
+
page_size?: number;
|
|
743
|
+
per_page?: number;
|
|
744
|
+
limit?: number;
|
|
745
|
+
override_page?: string | boolean;
|
|
746
|
+
q?: string;
|
|
747
|
+
search?: string;
|
|
748
|
+
sort?: string;
|
|
749
|
+
order?: 'asc' | 'desc';
|
|
750
|
+
}
|
|
751
|
+
/**
|
|
752
|
+
* Address query parameters with full type safety
|
|
753
|
+
*/
|
|
754
|
+
export interface AddressQueryParams {
|
|
755
|
+
id?: number | number[] | RangeQuery<number>;
|
|
756
|
+
kind?: number | number[];
|
|
757
|
+
kind_id?: number | number[];
|
|
758
|
+
lang?: number | number[] | RangeQuery<number>;
|
|
759
|
+
lat?: number | number[] | RangeQuery<number>;
|
|
760
|
+
hash?: string | string[] | StringQuery;
|
|
761
|
+
street?: string | string[] | StringQuery;
|
|
762
|
+
street_optional?: string | string[] | StringQuery;
|
|
763
|
+
city?: string | string[] | StringQuery;
|
|
764
|
+
state?: string | string[] | StringQuery;
|
|
765
|
+
country?: string | string[] | StringQuery;
|
|
766
|
+
region?: string | string[] | StringQuery;
|
|
767
|
+
town?: string | string[] | StringQuery;
|
|
768
|
+
inserted_at?: string | DateQuery;
|
|
769
|
+
updated_at?: string | DateQuery;
|
|
770
|
+
exclude?: string | number;
|
|
771
|
+
distinct?: string;
|
|
772
|
+
order_by?: string;
|
|
773
|
+
page?: number;
|
|
774
|
+
page_size?: number;
|
|
775
|
+
per_page?: number;
|
|
776
|
+
limit?: number;
|
|
777
|
+
override_page?: string | boolean;
|
|
778
|
+
q?: string;
|
|
779
|
+
search?: string;
|
|
780
|
+
sort?: string;
|
|
781
|
+
order?: 'asc' | 'desc';
|
|
782
|
+
}
|
|
783
|
+
/**
|
|
784
|
+
* Currency query parameters with full type safety
|
|
785
|
+
*/
|
|
786
|
+
export interface CurrencyQueryParams {
|
|
787
|
+
id?: number | number[] | RangeQuery<number>;
|
|
788
|
+
code?: string | string[] | StringQuery;
|
|
789
|
+
flag?: string | string[] | StringQuery;
|
|
790
|
+
is_float?: boolean;
|
|
791
|
+
inserted_at?: string | DateQuery;
|
|
792
|
+
updated_at?: string | DateQuery;
|
|
793
|
+
exclude?: string | number;
|
|
794
|
+
distinct?: string;
|
|
795
|
+
order_by?: string;
|
|
796
|
+
page?: number;
|
|
797
|
+
page_size?: number;
|
|
798
|
+
per_page?: number;
|
|
799
|
+
limit?: number;
|
|
800
|
+
override_page?: string | boolean;
|
|
801
|
+
q?: string;
|
|
802
|
+
search?: string;
|
|
803
|
+
sort?: string;
|
|
804
|
+
order?: 'asc' | 'desc';
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* Exchange Rate query parameters with full type safety
|
|
808
|
+
*/
|
|
809
|
+
export interface ExchangeRateQueryParams {
|
|
810
|
+
id?: number | number[] | RangeQuery<number>;
|
|
811
|
+
source_id?: number | number[];
|
|
812
|
+
destination_id?: number | number[];
|
|
813
|
+
rate?: number | number[] | RangeQuery<number>;
|
|
814
|
+
expires?: number | number[] | RangeQuery<number>;
|
|
815
|
+
user_id?: number | number[];
|
|
816
|
+
source?: string | string[] | StringQuery;
|
|
817
|
+
inserted_at?: string | DateQuery;
|
|
818
|
+
updated_at?: string | DateQuery;
|
|
819
|
+
exclude?: string | number;
|
|
820
|
+
distinct?: string;
|
|
821
|
+
order_by?: string;
|
|
822
|
+
page?: number;
|
|
823
|
+
page_size?: number;
|
|
824
|
+
per_page?: number;
|
|
825
|
+
limit?: number;
|
|
826
|
+
override_page?: string | boolean;
|
|
827
|
+
q?: string;
|
|
828
|
+
search?: string;
|
|
829
|
+
sort?: string;
|
|
830
|
+
order?: 'asc' | 'desc';
|
|
831
|
+
}
|
|
832
|
+
/**
|
|
833
|
+
* Fee query parameters with full type safety
|
|
834
|
+
*/
|
|
835
|
+
export interface FeeQueryParams {
|
|
836
|
+
id?: number | number[] | RangeQuery<number>;
|
|
837
|
+
total?: number | number[] | RangeQuery<number>;
|
|
838
|
+
unit?: number | number[];
|
|
839
|
+
kind?: number | number[];
|
|
840
|
+
priority?: number | number[] | RangeQuery<number>;
|
|
841
|
+
fee_payer?: number | number[];
|
|
842
|
+
fee_set_id?: number | number[];
|
|
843
|
+
currency_id?: number | number[];
|
|
844
|
+
user_id?: number | number[];
|
|
845
|
+
title?: string | string[] | StringQuery;
|
|
846
|
+
currency_code?: string | string[] | StringQuery;
|
|
847
|
+
hash?: string | string[] | StringQuery;
|
|
848
|
+
compound?: boolean;
|
|
849
|
+
inserted_at?: string | DateQuery;
|
|
850
|
+
updated_at?: string | DateQuery;
|
|
851
|
+
exclude?: string | number;
|
|
852
|
+
distinct?: string;
|
|
853
|
+
order_by?: string;
|
|
854
|
+
page?: number;
|
|
855
|
+
page_size?: number;
|
|
856
|
+
per_page?: number;
|
|
857
|
+
limit?: number;
|
|
858
|
+
override_page?: string | boolean;
|
|
859
|
+
q?: string;
|
|
860
|
+
search?: string;
|
|
861
|
+
sort?: string;
|
|
862
|
+
order?: 'asc' | 'desc';
|
|
863
|
+
}
|
|
864
|
+
/**
|
|
865
|
+
* Payment Method query parameters with full type safety
|
|
866
|
+
*/
|
|
867
|
+
export interface PaymentMethodQueryParams {
|
|
868
|
+
id?: number | number[] | RangeQuery<number>;
|
|
869
|
+
payment_provider_id?: number | number[];
|
|
870
|
+
financial_account_id?: number | number[];
|
|
871
|
+
name?: string | string[] | StringQuery;
|
|
872
|
+
code?: string | string[] | StringQuery;
|
|
873
|
+
provider?: string | string[] | StringQuery;
|
|
874
|
+
active?: boolean;
|
|
875
|
+
inserted_at?: string | DateQuery;
|
|
876
|
+
updated_at?: string | DateQuery;
|
|
877
|
+
exclude?: string | number;
|
|
878
|
+
distinct?: string;
|
|
879
|
+
order_by?: string;
|
|
880
|
+
page?: number;
|
|
881
|
+
page_size?: number;
|
|
882
|
+
per_page?: number;
|
|
883
|
+
limit?: number;
|
|
884
|
+
override_page?: string | boolean;
|
|
885
|
+
q?: string;
|
|
886
|
+
search?: string;
|
|
887
|
+
sort?: string;
|
|
888
|
+
order?: 'asc' | 'desc';
|
|
889
|
+
}
|
|
890
|
+
/**
|
|
891
|
+
* Transaction Entry query parameters with full type safety
|
|
892
|
+
*/
|
|
893
|
+
export interface TransactionEntryQueryParams {
|
|
894
|
+
id?: number | number[] | RangeQuery<number>;
|
|
895
|
+
amount?: number | number[] | RangeQuery<number>;
|
|
896
|
+
type?: number | number[];
|
|
897
|
+
transaction_id?: number | number[];
|
|
898
|
+
financial_account_id?: number | number[];
|
|
899
|
+
inserted_at?: string | DateQuery;
|
|
900
|
+
updated_at?: string | DateQuery;
|
|
901
|
+
exclude?: string | number;
|
|
902
|
+
distinct?: string;
|
|
903
|
+
order_by?: string;
|
|
904
|
+
page?: number;
|
|
905
|
+
page_size?: number;
|
|
906
|
+
per_page?: number;
|
|
907
|
+
limit?: number;
|
|
908
|
+
override_page?: string | boolean;
|
|
909
|
+
q?: string;
|
|
910
|
+
search?: string;
|
|
911
|
+
sort?: string;
|
|
912
|
+
order?: 'asc' | 'desc';
|
|
913
|
+
}
|
|
914
|
+
/**
|
|
915
|
+
* Order filter parameters (legacy)
|
|
916
|
+
* @deprecated Use OrderQueryParams with the query() method instead
|
|
917
|
+
*/
|
|
918
|
+
export interface OrderFilterParams extends BaseFilterParams {
|
|
919
|
+
search?: string;
|
|
920
|
+
status?: OrderStatus | StatusKey | number;
|
|
921
|
+
kind?: OrderKind | KindKey | number;
|
|
922
|
+
limit?: number;
|
|
923
|
+
id?: number;
|
|
924
|
+
reference_id?: string;
|
|
925
|
+
total?: number;
|
|
926
|
+
status_on?: number;
|
|
927
|
+
uid?: string;
|
|
928
|
+
cart_id?: number;
|
|
929
|
+
currency_id?: number;
|
|
930
|
+
customer_id?: number;
|
|
931
|
+
payment_link_id?: number;
|
|
932
|
+
billing_plan_id?: number;
|
|
933
|
+
session_id?: string;
|
|
934
|
+
inserted_at?: string;
|
|
935
|
+
updated_at?: string;
|
|
936
|
+
}
|
|
937
|
+
/**
|
|
938
|
+
* Product filter parameters (legacy)
|
|
939
|
+
* @deprecated Use ProductQueryParams with the query() method instead
|
|
940
|
+
*/
|
|
941
|
+
export interface ProductFilterParams extends BaseFilterParams {
|
|
942
|
+
search?: string;
|
|
943
|
+
status?: ProductStatus | StatusKey | number;
|
|
944
|
+
category?: string;
|
|
945
|
+
limit?: number;
|
|
946
|
+
id?: number;
|
|
947
|
+
title?: string;
|
|
948
|
+
teaser?: string;
|
|
949
|
+
price?: number;
|
|
950
|
+
permalink?: string;
|
|
951
|
+
image?: string;
|
|
952
|
+
public?: boolean;
|
|
953
|
+
unlimited?: boolean;
|
|
954
|
+
units_remaining?: number;
|
|
955
|
+
units_sold?: number;
|
|
956
|
+
rating_sum?: number;
|
|
957
|
+
rating_count?: number;
|
|
958
|
+
tag_ids?: number[];
|
|
959
|
+
uid?: string;
|
|
960
|
+
category_id?: number;
|
|
961
|
+
currency_id?: number;
|
|
962
|
+
user_id?: number;
|
|
963
|
+
inserted_at?: string;
|
|
964
|
+
updated_at?: string;
|
|
965
|
+
}
|
|
966
|
+
/**
|
|
967
|
+
* User filter parameters (legacy)
|
|
968
|
+
* @deprecated Use UserQueryParams with the query() method instead
|
|
969
|
+
*/
|
|
970
|
+
export interface UserFilterParams extends BaseFilterParams {
|
|
971
|
+
search?: string;
|
|
972
|
+
status?: AccountStatus | StatusKey | number;
|
|
973
|
+
kind?: UserKind | KindKey | number;
|
|
974
|
+
level?: number;
|
|
975
|
+
role_id?: number;
|
|
976
|
+
organisation_id?: number;
|
|
977
|
+
limit?: number;
|
|
978
|
+
id?: number;
|
|
979
|
+
email?: string;
|
|
980
|
+
phone?: string;
|
|
981
|
+
first_name?: string;
|
|
982
|
+
last_name?: string;
|
|
983
|
+
username?: string;
|
|
984
|
+
dob?: number;
|
|
985
|
+
sex?: number;
|
|
986
|
+
image?: string;
|
|
987
|
+
uid?: string;
|
|
988
|
+
inserted_at?: string;
|
|
989
|
+
updated_at?: string;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* Merchant filter parameters (legacy)
|
|
993
|
+
* @deprecated Use MerchantQueryParams with the query() method instead
|
|
994
|
+
*/
|
|
995
|
+
export interface MerchantFilterParams extends BaseFilterParams {
|
|
996
|
+
search?: string;
|
|
997
|
+
status?: AccountStatus | StatusKey | number;
|
|
998
|
+
limit?: number;
|
|
999
|
+
id?: number;
|
|
1000
|
+
name?: string;
|
|
1001
|
+
email?: string;
|
|
1002
|
+
username?: string;
|
|
1003
|
+
about?: string;
|
|
1004
|
+
logo?: string;
|
|
1005
|
+
sector?: string;
|
|
1006
|
+
phone?: string;
|
|
1007
|
+
business_type?: string;
|
|
1008
|
+
theme_colour?: string;
|
|
1009
|
+
uid?: string;
|
|
1010
|
+
address_id?: number;
|
|
1011
|
+
owner_id?: number;
|
|
1012
|
+
domain_id?: number;
|
|
1013
|
+
organisation_id?: number;
|
|
1014
|
+
platform_fee_structure?: FeeStructureKey | number;
|
|
1015
|
+
provider_fee_structure?: FeeStructureKey | number;
|
|
1016
|
+
parent_merchant_id?: number;
|
|
1017
|
+
inserted_at?: string;
|
|
1018
|
+
updated_at?: string;
|
|
1019
|
+
}
|
|
1020
|
+
/**
|
|
1021
|
+
* Category filter parameters (legacy)
|
|
1022
|
+
* @deprecated Use CategoryQueryParams with the query() method instead
|
|
1023
|
+
*/
|
|
1024
|
+
export interface CategoryFilterParams extends BaseFilterParams {
|
|
1025
|
+
search?: string;
|
|
1026
|
+
kind?: CategoryKind | KindKey | number;
|
|
1027
|
+
parent_id?: number;
|
|
1028
|
+
limit?: number;
|
|
1029
|
+
id?: number;
|
|
1030
|
+
name?: string;
|
|
1031
|
+
description?: string;
|
|
1032
|
+
kind_id?: number;
|
|
1033
|
+
uid?: string;
|
|
1034
|
+
inserted_at?: string;
|
|
1035
|
+
updated_at?: string;
|
|
1036
|
+
}
|
|
1037
|
+
/**
|
|
1038
|
+
* Billing Plan filter parameters (legacy)
|
|
1039
|
+
* @deprecated Use BillingPlanQueryParams with the query() method instead
|
|
1040
|
+
*/
|
|
1041
|
+
export interface BillingPlanFilterParams extends BaseFilterParams {
|
|
1042
|
+
status?: StatusKey | number;
|
|
1043
|
+
kind?: BillingPlanKind | KindKey | number;
|
|
1044
|
+
limit?: number;
|
|
1045
|
+
id?: number;
|
|
1046
|
+
name?: string;
|
|
1047
|
+
description?: string;
|
|
1048
|
+
flat_rate?: number;
|
|
1049
|
+
transaction_fee?: number;
|
|
1050
|
+
transaction_percentage?: number;
|
|
1051
|
+
transaction_percentage_additional?: number;
|
|
1052
|
+
transaction_minimum_fee?: number;
|
|
1053
|
+
minimum_fee?: number;
|
|
1054
|
+
duration?: number;
|
|
1055
|
+
billing_cycle?: number;
|
|
1056
|
+
trial_period?: number;
|
|
1057
|
+
charge_strategy?: number;
|
|
1058
|
+
auto_charge?: boolean;
|
|
1059
|
+
public?: boolean;
|
|
1060
|
+
payout_period?: number;
|
|
1061
|
+
payout_value_limit?: number;
|
|
1062
|
+
payout_percentage_limit?: number;
|
|
1063
|
+
uid?: string;
|
|
1064
|
+
currency_id?: number;
|
|
1065
|
+
payment_provider_id?: number;
|
|
1066
|
+
inserted_at?: string;
|
|
1067
|
+
updated_at?: string;
|
|
1068
|
+
}
|
|
1069
|
+
/**
|
|
1070
|
+
* Subscription filter parameters (legacy)
|
|
1071
|
+
* @deprecated Use SubscriptionQueryParams with the query() method instead
|
|
1072
|
+
*/
|
|
1073
|
+
export interface SubscriptionFilterParams extends BaseFilterParams {
|
|
1074
|
+
status?: SubscriptionStatus | StatusKey | number;
|
|
1075
|
+
billing_plan_id?: number;
|
|
1076
|
+
customer_id?: number;
|
|
1077
|
+
limit?: number;
|
|
1078
|
+
id?: number;
|
|
1079
|
+
record_id?: number;
|
|
1080
|
+
record?: string;
|
|
1081
|
+
start_date?: string;
|
|
1082
|
+
end_date?: string;
|
|
1083
|
+
current_period_start?: string;
|
|
1084
|
+
current_period_end?: string;
|
|
1085
|
+
trial_end?: string;
|
|
1086
|
+
canceled_at?: string;
|
|
1087
|
+
uid?: string;
|
|
1088
|
+
kind?: number;
|
|
1089
|
+
token?: string;
|
|
1090
|
+
inserted_at?: string;
|
|
1091
|
+
updated_at?: string;
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* Payment Link filter parameters (legacy)
|
|
1095
|
+
* @deprecated Use PaymentLinkQueryParams with the query() method instead
|
|
1096
|
+
*/
|
|
1097
|
+
export interface PaymentLinkFilterParams extends BaseFilterParams {
|
|
1098
|
+
status?: number;
|
|
1099
|
+
kind?: number;
|
|
1100
|
+
total?: number;
|
|
1101
|
+
customer_id?: number;
|
|
1102
|
+
currency_id?: number;
|
|
1103
|
+
order_id?: number;
|
|
1104
|
+
uid?: string;
|
|
1105
|
+
title?: string;
|
|
1106
|
+
limit?: number;
|
|
1107
|
+
}
|
|
1108
|
+
/**
|
|
1109
|
+
* Financial Account filter parameters (legacy)
|
|
1110
|
+
* @deprecated Use FinancialAccountQueryParams with the query() method instead
|
|
1111
|
+
*/
|
|
1112
|
+
export interface FinancialAccountFilterParams extends BaseFilterParams {
|
|
1113
|
+
type?: string;
|
|
1114
|
+
provider?: string;
|
|
1115
|
+
active?: boolean;
|
|
1116
|
+
is_external?: boolean;
|
|
1117
|
+
record_id?: number;
|
|
1118
|
+
limit?: number;
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* Financial Request filter parameters (legacy)
|
|
1122
|
+
* @deprecated Use FinancialRequestQueryParams with the query() method instead
|
|
1123
|
+
*/
|
|
1124
|
+
export interface FinancialRequestFilterParams extends BaseFilterParams {
|
|
1125
|
+
status?: number;
|
|
1126
|
+
type?: number;
|
|
1127
|
+
total?: number;
|
|
1128
|
+
merchant_id?: number;
|
|
1129
|
+
currency_id?: number;
|
|
1130
|
+
limit?: number;
|
|
1131
|
+
}
|
|
1132
|
+
/**
|
|
1133
|
+
* Webhook URL filter parameters (legacy)
|
|
1134
|
+
* @deprecated Use WebhookUrlQueryParams with the query() method instead
|
|
1135
|
+
*/
|
|
1136
|
+
export interface WebhookUrlFilterParams extends BaseFilterParams {
|
|
1137
|
+
event?: string;
|
|
1138
|
+
merchant_id?: number;
|
|
1139
|
+
org_id?: number;
|
|
1140
|
+
url?: string;
|
|
1141
|
+
limit?: number;
|
|
1142
|
+
}
|
|
1143
|
+
/**
|
|
1144
|
+
* Token filter parameters (legacy)
|
|
1145
|
+
* @deprecated Use TokenQueryParams with the query() method instead
|
|
1146
|
+
*/
|
|
1147
|
+
export interface TokenFilterParams extends BaseFilterParams {
|
|
1148
|
+
kind?: number;
|
|
1149
|
+
enabled?: boolean;
|
|
1150
|
+
user_id?: number;
|
|
1151
|
+
provider?: string;
|
|
1152
|
+
limit?: number;
|
|
1153
|
+
}
|
|
1154
|
+
/**
|
|
1155
|
+
* Address filter parameters (legacy)
|
|
1156
|
+
* @deprecated Use AddressQueryParams with the query() method instead
|
|
1157
|
+
*/
|
|
1158
|
+
export interface AddressFilterParams extends BaseFilterParams {
|
|
1159
|
+
kind?: number;
|
|
1160
|
+
country?: string;
|
|
1161
|
+
state?: string;
|
|
1162
|
+
city?: string;
|
|
1163
|
+
limit?: number;
|
|
1164
|
+
}
|
|
1165
|
+
/**
|
|
1166
|
+
* Currency filter parameters (legacy)
|
|
1167
|
+
* @deprecated Use CurrencyQueryParams with the query() method instead
|
|
1168
|
+
*/
|
|
1169
|
+
export interface CurrencyFilterParams extends BaseFilterParams {
|
|
1170
|
+
code?: string;
|
|
1171
|
+
is_float?: boolean;
|
|
1172
|
+
limit?: number;
|
|
1173
|
+
}
|
|
1174
|
+
/**
|
|
1175
|
+
* Exchange Rate filter parameters (legacy)
|
|
1176
|
+
* @deprecated Use ExchangeRateQueryParams with the query() method instead
|
|
1177
|
+
*/
|
|
1178
|
+
export interface ExchangeRateFilterParams extends BaseFilterParams {
|
|
1179
|
+
source_id?: number;
|
|
1180
|
+
destination_id?: number;
|
|
1181
|
+
rate?: number;
|
|
1182
|
+
limit?: number;
|
|
1183
|
+
}
|
|
1184
|
+
/**
|
|
1185
|
+
* Fee filter parameters (legacy)
|
|
1186
|
+
* @deprecated Use FeeQueryParams with the query() method instead
|
|
1187
|
+
*/
|
|
1188
|
+
export interface FeeFilterParams extends BaseFilterParams {
|
|
1189
|
+
kind?: number;
|
|
1190
|
+
total?: number;
|
|
1191
|
+
currency_code?: string;
|
|
1192
|
+
compound?: boolean;
|
|
1193
|
+
limit?: number;
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
* Payment Method filter parameters (legacy)
|
|
1197
|
+
* @deprecated Use PaymentMethodQueryParams with the query() method instead
|
|
1198
|
+
*/
|
|
1199
|
+
export interface PaymentMethodFilterParams extends BaseFilterParams {
|
|
1200
|
+
active?: boolean;
|
|
1201
|
+
provider?: string;
|
|
1202
|
+
code?: string;
|
|
1203
|
+
limit?: number;
|
|
1204
|
+
}
|
|
1205
|
+
/**
|
|
1206
|
+
* Transaction Entry filter parameters (legacy)
|
|
1207
|
+
* @deprecated Use TransactionEntryQueryParams with the query() method instead
|
|
1208
|
+
*/
|
|
1209
|
+
export interface TransactionEntryFilterParams extends BaseFilterParams {
|
|
1210
|
+
type?: number;
|
|
1211
|
+
amount?: number;
|
|
1212
|
+
transaction_id?: number;
|
|
1213
|
+
financial_account_id?: number;
|
|
1214
|
+
limit?: number;
|
|
1215
|
+
}
|
|
1216
|
+
export interface PageInfo {
|
|
1217
|
+
current_page: number;
|
|
1218
|
+
total_pages: number;
|
|
1219
|
+
total_entries: number;
|
|
1220
|
+
page_size: number;
|
|
1221
|
+
}
|
|
1222
|
+
export interface OrderListResponse {
|
|
1223
|
+
entries: Order[];
|
|
1224
|
+
page_info: PageInfo;
|
|
1225
|
+
}
|
|
1226
|
+
export interface ProductListResponse {
|
|
1227
|
+
entries: Product[];
|
|
1228
|
+
page_info: PageInfo;
|
|
1229
|
+
}
|
|
1230
|
+
export interface UserListResponse {
|
|
1231
|
+
entries: User[];
|
|
1232
|
+
page_info: PageInfo;
|
|
1233
|
+
}
|
|
1234
|
+
export interface MerchantListResponse {
|
|
1235
|
+
entries: Merchant[];
|
|
1236
|
+
page_info: PageInfo;
|
|
1237
|
+
}
|
|
1238
|
+
export interface CategoryListResponse {
|
|
1239
|
+
entries: Category[];
|
|
1240
|
+
page_info: PageInfo;
|
|
1241
|
+
}
|
|
1242
|
+
export interface BillingPlanListResponse {
|
|
1243
|
+
entries: BillingPlan[];
|
|
1244
|
+
page_info: PageInfo;
|
|
1245
|
+
}
|
|
1246
|
+
export interface SubscriptionListResponse {
|
|
1247
|
+
entries: Subscription[];
|
|
1248
|
+
page_info: PageInfo;
|
|
1249
|
+
}
|
|
1250
|
+
export interface PaymentLinkListResponse {
|
|
1251
|
+
entries: PaymentLink[];
|
|
1252
|
+
page_info: PageInfo;
|
|
1253
|
+
}
|
|
1254
|
+
export interface FinancialAccountListResponse {
|
|
1255
|
+
entries: FinancialAccount[];
|
|
1256
|
+
page_info: PageInfo;
|
|
1257
|
+
}
|
|
1258
|
+
export interface FinancialRequestListResponse {
|
|
1259
|
+
entries: FinancialRequest[];
|
|
1260
|
+
page_info: PageInfo;
|
|
1261
|
+
}
|
|
1262
|
+
export interface WebhookUrlListResponse {
|
|
1263
|
+
entries: WebhookUrl[];
|
|
1264
|
+
page_info: PageInfo;
|
|
1265
|
+
}
|
|
1266
|
+
export interface TokenListResponse {
|
|
1267
|
+
entries: Token[];
|
|
1268
|
+
page_info: PageInfo;
|
|
1269
|
+
}
|
|
1270
|
+
export interface AddressListResponse {
|
|
1271
|
+
entries: Address[];
|
|
1272
|
+
page_info: PageInfo;
|
|
1273
|
+
}
|
|
1274
|
+
export interface CurrencyListResponse {
|
|
1275
|
+
entries: Currency[];
|
|
1276
|
+
page_info: PageInfo;
|
|
1277
|
+
}
|
|
1278
|
+
export interface ExchangeRateListResponse {
|
|
1279
|
+
entries: ExchangeRate[];
|
|
1280
|
+
page_info: PageInfo;
|
|
1281
|
+
}
|
|
1282
|
+
export interface FeeListResponse {
|
|
1283
|
+
entries: Fee[];
|
|
1284
|
+
page_info: PageInfo;
|
|
1285
|
+
}
|
|
1286
|
+
export interface PaymentMethodListResponse {
|
|
1287
|
+
entries: PaymentMethod[];
|
|
1288
|
+
page_info: PageInfo;
|
|
1289
|
+
}
|
|
1290
|
+
export interface TransactionEntryListResponse {
|
|
1291
|
+
entries: TransactionEntry[];
|
|
1292
|
+
page_info: PageInfo;
|
|
1293
|
+
}
|
|
1294
|
+
//# sourceMappingURL=resources.d.ts.map
|