@firela/api-types 0.0.0-canary.c5520a90 → 0.0.0-canary.c79f5035
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/dist/index.d.mts +2062 -1308
- package/dist/index.d.ts +2062 -1308
- package/dist/index.js +30 -4
- package/dist/index.mjs +30 -4
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +3604 -2827
- package/src/generated/services.gen.ts +1147 -816
- package/src/generated/types.gen.ts +2284 -1385
|
@@ -6,13 +6,9 @@ export type CreateAccountDto = {
|
|
|
6
6
|
*/
|
|
7
7
|
path: string;
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Account open date (server defaults to today)
|
|
10
10
|
*/
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* Account open date
|
|
14
|
-
*/
|
|
15
|
-
openDate: string;
|
|
11
|
+
openDate?: string;
|
|
16
12
|
/**
|
|
17
13
|
* Allowed currencies (null = no restriction)
|
|
18
14
|
*/
|
|
@@ -36,18 +32,14 @@ export type CreateAccountDto = {
|
|
|
36
32
|
* Whether this is a custom (user-created) account
|
|
37
33
|
*/
|
|
38
34
|
isCustom?: boolean;
|
|
39
|
-
/**
|
|
40
|
-
* i18n key for display name (overrides template)
|
|
41
|
-
*/
|
|
42
|
-
i18nKey?: string;
|
|
43
35
|
/**
|
|
44
36
|
* Icon identifier (overrides template)
|
|
45
37
|
*/
|
|
46
38
|
icon?: string;
|
|
47
39
|
/**
|
|
48
|
-
*
|
|
40
|
+
* Open directive metadata (NOT an opening-balance amount — use the opening-balance endpoint)
|
|
49
41
|
*/
|
|
50
|
-
|
|
42
|
+
openDirectiveMeta?: {
|
|
51
43
|
[key: string]: unknown;
|
|
52
44
|
};
|
|
53
45
|
/**
|
|
@@ -77,14 +69,47 @@ export type AccountResponseDto = {
|
|
|
77
69
|
* Account path (hierarchical, colon-separated)
|
|
78
70
|
*/
|
|
79
71
|
path: string;
|
|
80
|
-
/**
|
|
81
|
-
* Display name distinguishing multiple accounts at the same path
|
|
82
|
-
*/
|
|
83
|
-
displayName: string;
|
|
84
72
|
/**
|
|
85
73
|
* Account type (root segment)
|
|
86
74
|
*/
|
|
87
75
|
type: 'Assets' | 'Liabilities' | 'Income' | 'Expenses' | 'Equity';
|
|
76
|
+
/**
|
|
77
|
+
* Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.
|
|
78
|
+
*/
|
|
79
|
+
assetSubClass?:
|
|
80
|
+
| 'DEPOSIT'
|
|
81
|
+
| 'CASH'
|
|
82
|
+
| 'MONEY_MARKET_FUND'
|
|
83
|
+
| 'STOCK'
|
|
84
|
+
| 'ETF'
|
|
85
|
+
| 'MUTUAL_FUND'
|
|
86
|
+
| 'EQUITY_COMPENSATION'
|
|
87
|
+
| 'GOVERNMENT_BOND'
|
|
88
|
+
| 'CORPORATE_BOND'
|
|
89
|
+
| 'BOND_FUND'
|
|
90
|
+
| 'PRIMARY_RESIDENCE'
|
|
91
|
+
| 'INVESTMENT_PROPERTY'
|
|
92
|
+
| 'REIT'
|
|
93
|
+
| 'GOLD'
|
|
94
|
+
| 'SILVER'
|
|
95
|
+
| 'PRECIOUS_METAL'
|
|
96
|
+
| 'PRECIOUS_METAL_FUND'
|
|
97
|
+
| 'COMMODITY'
|
|
98
|
+
| 'COMMODITY_FUND'
|
|
99
|
+
| 'CRYPTOCURRENCY'
|
|
100
|
+
| 'RETIREMENT_ACCOUNT'
|
|
101
|
+
| 'HEALTH_ACCOUNT'
|
|
102
|
+
| 'EDUCATION_ACCOUNT'
|
|
103
|
+
| 'INSURANCE'
|
|
104
|
+
| 'PRIVATE_EQUITY'
|
|
105
|
+
| 'HEDGE_FUND'
|
|
106
|
+
| 'COLLECTIBLES'
|
|
107
|
+
| 'MORTGAGE'
|
|
108
|
+
| 'STUDENT_LOAN'
|
|
109
|
+
| 'CREDIT_CARD'
|
|
110
|
+
| 'PERSONAL_LOAN'
|
|
111
|
+
| 'OTHER'
|
|
112
|
+
| null;
|
|
88
113
|
/**
|
|
89
114
|
* Account status
|
|
90
115
|
*/
|
|
@@ -121,17 +146,17 @@ export type AccountResponseDto = {
|
|
|
121
146
|
*/
|
|
122
147
|
isCustom: boolean;
|
|
123
148
|
/**
|
|
124
|
-
*
|
|
149
|
+
* Localized display name (ADR-0114, read-time projection)
|
|
125
150
|
*/
|
|
126
|
-
|
|
151
|
+
displayName?: string;
|
|
127
152
|
/**
|
|
128
153
|
* Icon identifier
|
|
129
154
|
*/
|
|
130
155
|
icon?: string;
|
|
131
156
|
/**
|
|
132
|
-
*
|
|
157
|
+
* Open directive metadata (ADR-0115 Decision 9)
|
|
133
158
|
*/
|
|
134
|
-
|
|
159
|
+
openDirectiveMeta?: {
|
|
135
160
|
[key: string]: unknown;
|
|
136
161
|
};
|
|
137
162
|
/**
|
|
@@ -161,6 +186,43 @@ export type AccountResponseDto = {
|
|
|
161
186
|
*/
|
|
162
187
|
export type type = 'Assets' | 'Liabilities' | 'Income' | 'Expenses' | 'Equity';
|
|
163
188
|
|
|
189
|
+
/**
|
|
190
|
+
* Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.
|
|
191
|
+
*/
|
|
192
|
+
export type assetSubClass =
|
|
193
|
+
| 'DEPOSIT'
|
|
194
|
+
| 'CASH'
|
|
195
|
+
| 'MONEY_MARKET_FUND'
|
|
196
|
+
| 'STOCK'
|
|
197
|
+
| 'ETF'
|
|
198
|
+
| 'MUTUAL_FUND'
|
|
199
|
+
| 'EQUITY_COMPENSATION'
|
|
200
|
+
| 'GOVERNMENT_BOND'
|
|
201
|
+
| 'CORPORATE_BOND'
|
|
202
|
+
| 'BOND_FUND'
|
|
203
|
+
| 'PRIMARY_RESIDENCE'
|
|
204
|
+
| 'INVESTMENT_PROPERTY'
|
|
205
|
+
| 'REIT'
|
|
206
|
+
| 'GOLD'
|
|
207
|
+
| 'SILVER'
|
|
208
|
+
| 'PRECIOUS_METAL'
|
|
209
|
+
| 'PRECIOUS_METAL_FUND'
|
|
210
|
+
| 'COMMODITY'
|
|
211
|
+
| 'COMMODITY_FUND'
|
|
212
|
+
| 'CRYPTOCURRENCY'
|
|
213
|
+
| 'RETIREMENT_ACCOUNT'
|
|
214
|
+
| 'HEALTH_ACCOUNT'
|
|
215
|
+
| 'EDUCATION_ACCOUNT'
|
|
216
|
+
| 'INSURANCE'
|
|
217
|
+
| 'PRIVATE_EQUITY'
|
|
218
|
+
| 'HEDGE_FUND'
|
|
219
|
+
| 'COLLECTIBLES'
|
|
220
|
+
| 'MORTGAGE'
|
|
221
|
+
| 'STUDENT_LOAN'
|
|
222
|
+
| 'CREDIT_CARD'
|
|
223
|
+
| 'PERSONAL_LOAN'
|
|
224
|
+
| 'OTHER';
|
|
225
|
+
|
|
164
226
|
/**
|
|
165
227
|
* Account status
|
|
166
228
|
*/
|
|
@@ -178,10 +240,6 @@ export type AccountListResponseDto = {
|
|
|
178
240
|
};
|
|
179
241
|
|
|
180
242
|
export type UpdateAccountDto = {
|
|
181
|
-
/**
|
|
182
|
-
* Display name to distinguish accounts at the same path
|
|
183
|
-
*/
|
|
184
|
-
displayName?: string;
|
|
185
243
|
/**
|
|
186
244
|
* Allowed currencies (null = no restriction)
|
|
187
245
|
*/
|
|
@@ -197,18 +255,14 @@ export type UpdateAccountDto = {
|
|
|
197
255
|
| 'STRICT'
|
|
198
256
|
| 'STRICT_WITH_SIZE'
|
|
199
257
|
| 'NONE';
|
|
200
|
-
/**
|
|
201
|
-
* i18n key for display name
|
|
202
|
-
*/
|
|
203
|
-
i18nKey?: string;
|
|
204
258
|
/**
|
|
205
259
|
* Icon identifier
|
|
206
260
|
*/
|
|
207
261
|
icon?: string;
|
|
208
262
|
/**
|
|
209
|
-
*
|
|
263
|
+
* Open directive metadata (merged with existing; NOT an opening-balance amount)
|
|
210
264
|
*/
|
|
211
|
-
|
|
265
|
+
openDirectiveMeta?: {
|
|
212
266
|
[key: string]: unknown;
|
|
213
267
|
};
|
|
214
268
|
/**
|
|
@@ -237,6 +291,28 @@ export type ReopenAccountDto = {
|
|
|
237
291
|
reopenDate?: string;
|
|
238
292
|
};
|
|
239
293
|
|
|
294
|
+
export type CreateOpeningBalanceDto = {
|
|
295
|
+
/**
|
|
296
|
+
* Opening balance amount (non-negative)
|
|
297
|
+
*/
|
|
298
|
+
amount: number;
|
|
299
|
+
/**
|
|
300
|
+
* Currency code
|
|
301
|
+
*/
|
|
302
|
+
currency: string;
|
|
303
|
+
/**
|
|
304
|
+
* Opening-balance date (defaults to now)
|
|
305
|
+
*/
|
|
306
|
+
date?: string;
|
|
307
|
+
};
|
|
308
|
+
|
|
309
|
+
export type OpeningBalanceResultDto = {
|
|
310
|
+
/**
|
|
311
|
+
* Created opening-balance transaction id.
|
|
312
|
+
*/
|
|
313
|
+
transactionId: string;
|
|
314
|
+
};
|
|
315
|
+
|
|
240
316
|
export type AccountStandardResponseDto = {
|
|
241
317
|
/**
|
|
242
318
|
* Account path (hierarchical, colon-separated)
|
|
@@ -246,10 +322,6 @@ export type AccountStandardResponseDto = {
|
|
|
246
322
|
* Account type in Beancount hierarchy
|
|
247
323
|
*/
|
|
248
324
|
type: 'Assets' | 'Liabilities' | 'Income' | 'Expenses' | 'Equity';
|
|
249
|
-
/**
|
|
250
|
-
* i18n key for localized display name
|
|
251
|
-
*/
|
|
252
|
-
i18nKey: string;
|
|
253
325
|
/**
|
|
254
326
|
* Short localized display name
|
|
255
327
|
*/
|
|
@@ -284,10 +356,6 @@ export type AccountStandardListResponseDto = {
|
|
|
284
356
|
};
|
|
285
357
|
|
|
286
358
|
export type TemplateMetadataDto = {
|
|
287
|
-
/**
|
|
288
|
-
* Whether this path can be extended
|
|
289
|
-
*/
|
|
290
|
-
extendable: boolean;
|
|
291
359
|
/**
|
|
292
360
|
* Root account type
|
|
293
361
|
*/
|
|
@@ -848,6 +916,51 @@ export type flag2 =
|
|
|
848
916
|
*/
|
|
849
917
|
export type status2 = 'ACTIVE' | 'VOIDED' | 'SUPERSEDED';
|
|
850
918
|
|
|
919
|
+
export type BalanceByCurrencyDto = {
|
|
920
|
+
/**
|
|
921
|
+
* ISO 4217 currency code
|
|
922
|
+
*/
|
|
923
|
+
currency: string;
|
|
924
|
+
/**
|
|
925
|
+
* Balance amount
|
|
926
|
+
*/
|
|
927
|
+
balance: string;
|
|
928
|
+
};
|
|
929
|
+
|
|
930
|
+
export type ExchangeRateWarningDto = {
|
|
931
|
+
/**
|
|
932
|
+
* Warning type
|
|
933
|
+
*/
|
|
934
|
+
type: string;
|
|
935
|
+
/**
|
|
936
|
+
* Currency without exchange rate
|
|
937
|
+
*/
|
|
938
|
+
currency: string;
|
|
939
|
+
/**
|
|
940
|
+
* Total amount affected
|
|
941
|
+
*/
|
|
942
|
+
totalAmount: string;
|
|
943
|
+
};
|
|
944
|
+
|
|
945
|
+
export type TransactionListSummaryDto = {
|
|
946
|
+
/**
|
|
947
|
+
* Partial converted total in base currency (rated currencies only, raw Beancount sign). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.
|
|
948
|
+
*/
|
|
949
|
+
totalAmount: string;
|
|
950
|
+
/**
|
|
951
|
+
* Base currency (ISO 4217)
|
|
952
|
+
*/
|
|
953
|
+
currency: string;
|
|
954
|
+
/**
|
|
955
|
+
* Raw (unconverted) balance per currency
|
|
956
|
+
*/
|
|
957
|
+
balanceByCurrency: Array<BalanceByCurrencyDto>;
|
|
958
|
+
/**
|
|
959
|
+
* Currencies missing an FX rate (omitted when empty)
|
|
960
|
+
*/
|
|
961
|
+
warnings?: Array<ExchangeRateWarningDto>;
|
|
962
|
+
};
|
|
963
|
+
|
|
851
964
|
export type TransactionListResponseDto = {
|
|
852
965
|
/**
|
|
853
966
|
* List of transactions
|
|
@@ -865,6 +978,10 @@ export type TransactionListResponseDto = {
|
|
|
865
978
|
* Number of items skipped
|
|
866
979
|
*/
|
|
867
980
|
offset: number;
|
|
981
|
+
/**
|
|
982
|
+
* Amount summary for the full filtered set (#514). Present only when the request has a single account OR category viewpoint; omitted for search-only / plain-list / dual-perspective requests.
|
|
983
|
+
*/
|
|
984
|
+
summary?: TransactionListSummaryDto;
|
|
868
985
|
};
|
|
869
986
|
|
|
870
987
|
export type TagSuggestionDto = {
|
|
@@ -1917,6 +2034,108 @@ export type UpdateCommodityDto = {
|
|
|
1917
2034
|
};
|
|
1918
2035
|
};
|
|
1919
2036
|
|
|
2037
|
+
export type CreateBeanPriceDto = {
|
|
2038
|
+
/**
|
|
2039
|
+
* Currency being priced (e.g., USD, AAPL, BTC)
|
|
2040
|
+
*/
|
|
2041
|
+
currency: string;
|
|
2042
|
+
/**
|
|
2043
|
+
* Quote currency (pricing currency, e.g., CNY, EUR)
|
|
2044
|
+
*/
|
|
2045
|
+
quoteCurrency: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.
|
|
2048
|
+
*/
|
|
2049
|
+
amount: number;
|
|
2050
|
+
/**
|
|
2051
|
+
* Price date (ISO 8601 format)
|
|
2052
|
+
*/
|
|
2053
|
+
date: string;
|
|
2054
|
+
/**
|
|
2055
|
+
* Metadata (validated by Zod schema, max field lengths enforced)
|
|
2056
|
+
*/
|
|
2057
|
+
metadata?: {
|
|
2058
|
+
[key: string]: unknown;
|
|
2059
|
+
};
|
|
2060
|
+
};
|
|
2061
|
+
|
|
2062
|
+
export type PriceResponseDto = {
|
|
2063
|
+
/**
|
|
2064
|
+
* Unique identifier
|
|
2065
|
+
*/
|
|
2066
|
+
id: string;
|
|
2067
|
+
/**
|
|
2068
|
+
* User ID (owner of the price)
|
|
2069
|
+
*/
|
|
2070
|
+
userId: string;
|
|
2071
|
+
/**
|
|
2072
|
+
* Currency being priced (e.g., USD, AAPL, BTC)
|
|
2073
|
+
*/
|
|
2074
|
+
currency: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* Quote currency (pricing currency, e.g., USD, CNY)
|
|
2077
|
+
*/
|
|
2078
|
+
quoteCurrency: string;
|
|
2079
|
+
/**
|
|
2080
|
+
* Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.
|
|
2081
|
+
*/
|
|
2082
|
+
amount: number;
|
|
2083
|
+
/**
|
|
2084
|
+
* Price date (ISO 8601 format). Represents the date this price was valid.
|
|
2085
|
+
*/
|
|
2086
|
+
date: string;
|
|
2087
|
+
/**
|
|
2088
|
+
* Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.
|
|
2089
|
+
*/
|
|
2090
|
+
meta: {
|
|
2091
|
+
[key: string]: unknown;
|
|
2092
|
+
};
|
|
2093
|
+
/**
|
|
2094
|
+
* Creation timestamp
|
|
2095
|
+
*/
|
|
2096
|
+
createdAt: string;
|
|
2097
|
+
/**
|
|
2098
|
+
* Last update timestamp
|
|
2099
|
+
*/
|
|
2100
|
+
updatedAt: string;
|
|
2101
|
+
};
|
|
2102
|
+
|
|
2103
|
+
export type PriceListResponseDto = {
|
|
2104
|
+
/**
|
|
2105
|
+
* List of prices
|
|
2106
|
+
*/
|
|
2107
|
+
items: Array<PriceResponseDto>;
|
|
2108
|
+
/**
|
|
2109
|
+
* Total number of prices
|
|
2110
|
+
*/
|
|
2111
|
+
total: number;
|
|
2112
|
+
};
|
|
2113
|
+
|
|
2114
|
+
export type UpdateBeanPriceDto = {
|
|
2115
|
+
/**
|
|
2116
|
+
* Currency being priced
|
|
2117
|
+
*/
|
|
2118
|
+
currency?: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* Quote currency (pricing currency)
|
|
2121
|
+
*/
|
|
2122
|
+
quoteCurrency?: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* Price amount (MUST be >= 0 per Beancount spec)
|
|
2125
|
+
*/
|
|
2126
|
+
amount?: number;
|
|
2127
|
+
/**
|
|
2128
|
+
* Price date (ISO 8601 format)
|
|
2129
|
+
*/
|
|
2130
|
+
date?: string;
|
|
2131
|
+
/**
|
|
2132
|
+
* Metadata
|
|
2133
|
+
*/
|
|
2134
|
+
metadata?: {
|
|
2135
|
+
[key: string]: unknown;
|
|
2136
|
+
};
|
|
2137
|
+
};
|
|
2138
|
+
|
|
1920
2139
|
export type CreateRecurringRuleDto = {
|
|
1921
2140
|
/**
|
|
1922
2141
|
* Rule name (unique per user)
|
|
@@ -2556,64 +2775,376 @@ export type ForecastResponseDto = {
|
|
|
2556
2775
|
periodEnd: string;
|
|
2557
2776
|
};
|
|
2558
2777
|
|
|
2559
|
-
export type
|
|
2560
|
-
name: string;
|
|
2561
|
-
description?: string;
|
|
2562
|
-
narrationKeywords?: Array<unknown[]>;
|
|
2563
|
-
payeeKeywords?: Array<unknown[]>;
|
|
2564
|
-
categoryKeywords?: Array<unknown[]>;
|
|
2778
|
+
export type CurrencyBalanceDto = {
|
|
2565
2779
|
/**
|
|
2566
|
-
*
|
|
2780
|
+
* ISO 4217 currency code
|
|
2567
2781
|
*/
|
|
2568
|
-
|
|
2782
|
+
currency: string;
|
|
2569
2783
|
/**
|
|
2570
|
-
*
|
|
2784
|
+
* Balance amount
|
|
2571
2785
|
*/
|
|
2572
|
-
|
|
2573
|
-
|
|
2786
|
+
balance: string;
|
|
2787
|
+
};
|
|
2788
|
+
|
|
2789
|
+
export type TimeSeriesPointDto = {
|
|
2574
2790
|
/**
|
|
2575
|
-
*
|
|
2791
|
+
* Date in YYYY-MM-DD format
|
|
2576
2792
|
*/
|
|
2577
|
-
|
|
2793
|
+
date: string;
|
|
2578
2794
|
/**
|
|
2579
|
-
*
|
|
2795
|
+
* Value at this date (in base currency)
|
|
2580
2796
|
*/
|
|
2581
|
-
|
|
2582
|
-
|
|
2583
|
-
|
|
2584
|
-
|
|
2797
|
+
value: string;
|
|
2798
|
+
/**
|
|
2799
|
+
* Change from previous point
|
|
2800
|
+
*/
|
|
2801
|
+
change?: {
|
|
2585
2802
|
[key: string]: unknown;
|
|
2586
2803
|
};
|
|
2587
2804
|
/**
|
|
2588
|
-
*
|
|
2805
|
+
* Total assets at this date (in base currency)
|
|
2589
2806
|
*/
|
|
2590
|
-
|
|
2591
|
-
};
|
|
2592
|
-
|
|
2593
|
-
export type matchLogic = 'OR' | 'AND';
|
|
2594
|
-
|
|
2595
|
-
export type AmountRangeDto = {
|
|
2807
|
+
assets?: string;
|
|
2596
2808
|
/**
|
|
2597
|
-
*
|
|
2809
|
+
* Total liabilities at this date (in base currency)
|
|
2598
2810
|
*/
|
|
2599
|
-
|
|
2811
|
+
liabilities?: string;
|
|
2600
2812
|
/**
|
|
2601
|
-
*
|
|
2813
|
+
* Multi-currency breakdown for this point
|
|
2602
2814
|
*/
|
|
2603
|
-
|
|
2815
|
+
byCurrency?: Array<CurrencyBalanceDto>;
|
|
2604
2816
|
};
|
|
2605
2817
|
|
|
2606
|
-
export type
|
|
2818
|
+
export type TrendSummaryDto = {
|
|
2607
2819
|
/**
|
|
2608
|
-
*
|
|
2820
|
+
* Value at start of period
|
|
2609
2821
|
*/
|
|
2610
|
-
|
|
2822
|
+
startValue: string;
|
|
2611
2823
|
/**
|
|
2612
|
-
*
|
|
2824
|
+
* Value at end of period
|
|
2613
2825
|
*/
|
|
2614
|
-
|
|
2826
|
+
endValue: string;
|
|
2615
2827
|
/**
|
|
2616
|
-
*
|
|
2828
|
+
* Total change over period
|
|
2829
|
+
*/
|
|
2830
|
+
totalChange: string;
|
|
2831
|
+
/**
|
|
2832
|
+
* Total change percentage
|
|
2833
|
+
*/
|
|
2834
|
+
totalChangePercentage: string;
|
|
2835
|
+
};
|
|
2836
|
+
|
|
2837
|
+
export type MultiCurrencyPointDto = {
|
|
2838
|
+
/**
|
|
2839
|
+
* Date in YYYY-MM-DD format
|
|
2840
|
+
*/
|
|
2841
|
+
date: string;
|
|
2842
|
+
/**
|
|
2843
|
+
* Balances by currency
|
|
2844
|
+
*/
|
|
2845
|
+
byCurrency: Array<CurrencyBalanceDto>;
|
|
2846
|
+
};
|
|
2847
|
+
|
|
2848
|
+
export type PortfolioTrendsResponseDto = {
|
|
2849
|
+
/**
|
|
2850
|
+
* Time series data points
|
|
2851
|
+
*/
|
|
2852
|
+
series: Array<TimeSeriesPointDto>;
|
|
2853
|
+
/**
|
|
2854
|
+
* Period summary
|
|
2855
|
+
*/
|
|
2856
|
+
summary: TrendSummaryDto;
|
|
2857
|
+
/**
|
|
2858
|
+
* Period requested
|
|
2859
|
+
*/
|
|
2860
|
+
period: string;
|
|
2861
|
+
/**
|
|
2862
|
+
* Data granularity
|
|
2863
|
+
*/
|
|
2864
|
+
granularity: string;
|
|
2865
|
+
/**
|
|
2866
|
+
* Base currency for converted values
|
|
2867
|
+
*/
|
|
2868
|
+
currency: string;
|
|
2869
|
+
/**
|
|
2870
|
+
* Multi-currency time series (each point has currency breakdown)
|
|
2871
|
+
*/
|
|
2872
|
+
byCurrency?: Array<MultiCurrencyPointDto>;
|
|
2873
|
+
/**
|
|
2874
|
+
* Exchange rate warnings
|
|
2875
|
+
*/
|
|
2876
|
+
warnings?: Array<ExchangeRateWarningDto>;
|
|
2877
|
+
};
|
|
2878
|
+
|
|
2879
|
+
export type CashFlowPointDto = {
|
|
2880
|
+
/**
|
|
2881
|
+
* Month key (YYYY-MM)
|
|
2882
|
+
*/
|
|
2883
|
+
month: string;
|
|
2884
|
+
/**
|
|
2885
|
+
* Income in base currency (absolute, converted)
|
|
2886
|
+
*/
|
|
2887
|
+
income: string;
|
|
2888
|
+
/**
|
|
2889
|
+
* Expense in base currency (absolute, converted)
|
|
2890
|
+
*/
|
|
2891
|
+
expense: string;
|
|
2892
|
+
/**
|
|
2893
|
+
* netSavings = income − expense (savings positive)
|
|
2894
|
+
*/
|
|
2895
|
+
netSavings: string;
|
|
2896
|
+
};
|
|
2897
|
+
|
|
2898
|
+
export type CashFlowTrendSummaryDto = {
|
|
2899
|
+
/**
|
|
2900
|
+
* Total income across the period
|
|
2901
|
+
*/
|
|
2902
|
+
totalIncome: string;
|
|
2903
|
+
/**
|
|
2904
|
+
* Total expense across the period
|
|
2905
|
+
*/
|
|
2906
|
+
totalExpense: string;
|
|
2907
|
+
/**
|
|
2908
|
+
* income − expense across the period
|
|
2909
|
+
*/
|
|
2910
|
+
totalNetSavings: string;
|
|
2911
|
+
/**
|
|
2912
|
+
* totalNetSavings divided by the window length (N months, incl. zero-filled)
|
|
2913
|
+
*/
|
|
2914
|
+
averageMonthlyNetSavings: string;
|
|
2915
|
+
};
|
|
2916
|
+
|
|
2917
|
+
export type CashFlowTrendsResponseDto = {
|
|
2918
|
+
/**
|
|
2919
|
+
* Monthly cash-flow series (fixed N-month window, zero-filled)
|
|
2920
|
+
*/
|
|
2921
|
+
series: Array<CashFlowPointDto>;
|
|
2922
|
+
/**
|
|
2923
|
+
* Period totals
|
|
2924
|
+
*/
|
|
2925
|
+
summary: CashFlowTrendSummaryDto;
|
|
2926
|
+
/**
|
|
2927
|
+
* Period requested
|
|
2928
|
+
*/
|
|
2929
|
+
period: string;
|
|
2930
|
+
/**
|
|
2931
|
+
* Data granularity (v1 returns month buckets)
|
|
2932
|
+
*/
|
|
2933
|
+
granularity: string;
|
|
2934
|
+
/**
|
|
2935
|
+
* Base currency for converted values
|
|
2936
|
+
*/
|
|
2937
|
+
currency: string;
|
|
2938
|
+
/**
|
|
2939
|
+
* Exchange rate warnings (e.g. missing rate for a currency)
|
|
2940
|
+
*/
|
|
2941
|
+
warnings?: Array<ExchangeRateWarningDto>;
|
|
2942
|
+
};
|
|
2943
|
+
|
|
2944
|
+
export type GenerateSnapshotBody = unknown;
|
|
2945
|
+
|
|
2946
|
+
export type GenerateSnapshotResponse = unknown;
|
|
2947
|
+
|
|
2948
|
+
export type BackfillSnapshotsBody = unknown;
|
|
2949
|
+
|
|
2950
|
+
export type BackfillSnapshotsResponse = unknown;
|
|
2951
|
+
|
|
2952
|
+
export type DeleteOwnUserDto = {
|
|
2953
|
+
/**
|
|
2954
|
+
* Access token for user verification
|
|
2955
|
+
*/
|
|
2956
|
+
accessToken: string;
|
|
2957
|
+
};
|
|
2958
|
+
|
|
2959
|
+
export type SignupDto = {
|
|
2960
|
+
/**
|
|
2961
|
+
* Cloudflare Turnstile verification token (optional when Turnstile disabled)
|
|
2962
|
+
*/
|
|
2963
|
+
turnstileToken?: string;
|
|
2964
|
+
};
|
|
2965
|
+
|
|
2966
|
+
export type SignupResponseDto = {
|
|
2967
|
+
/**
|
|
2968
|
+
* JWT auth token
|
|
2969
|
+
*/
|
|
2970
|
+
authToken: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* Auto-generated access token
|
|
2973
|
+
*/
|
|
2974
|
+
accessToken: string;
|
|
2975
|
+
/**
|
|
2976
|
+
* Assigned user role
|
|
2977
|
+
*/
|
|
2978
|
+
role: 'USER' | 'ADMIN' | 'DEMO' | 'INACTIVE' | 'PAID' | 'OPS';
|
|
2979
|
+
};
|
|
2980
|
+
|
|
2981
|
+
/**
|
|
2982
|
+
* Assigned user role
|
|
2983
|
+
*/
|
|
2984
|
+
export type role = 'USER' | 'ADMIN' | 'DEMO' | 'INACTIVE' | 'PAID' | 'OPS';
|
|
2985
|
+
|
|
2986
|
+
export type UpdateUserSettingDto = {
|
|
2987
|
+
/**
|
|
2988
|
+
* Security ID
|
|
2989
|
+
*/
|
|
2990
|
+
secId?: number;
|
|
2991
|
+
/**
|
|
2992
|
+
* Annual interest rate
|
|
2993
|
+
*/
|
|
2994
|
+
annualInterestRate?: number;
|
|
2995
|
+
/**
|
|
2996
|
+
* Currency code
|
|
2997
|
+
*/
|
|
2998
|
+
currency?: string;
|
|
2999
|
+
/**
|
|
3000
|
+
* Base currency code
|
|
3001
|
+
*/
|
|
3002
|
+
baseCurrency?: string;
|
|
3003
|
+
/**
|
|
3004
|
+
* Benchmark symbol
|
|
3005
|
+
*/
|
|
3006
|
+
benchmark?: string;
|
|
3007
|
+
/**
|
|
3008
|
+
* Color scheme
|
|
3009
|
+
*/
|
|
3010
|
+
colorScheme?: 'DARK' | 'LIGHT';
|
|
3011
|
+
/**
|
|
3012
|
+
* Date range filter
|
|
3013
|
+
*/
|
|
3014
|
+
dateRange?: string;
|
|
3015
|
+
/**
|
|
3016
|
+
* Emergency fund amount
|
|
3017
|
+
*/
|
|
3018
|
+
emergencyFund?: number;
|
|
3019
|
+
/**
|
|
3020
|
+
* Account filter IDs
|
|
3021
|
+
*/
|
|
3022
|
+
'filters.accounts'?: Array<string>;
|
|
3023
|
+
/**
|
|
3024
|
+
* Asset class filters
|
|
3025
|
+
*/
|
|
3026
|
+
'filters.assetClasses'?: Array<string>;
|
|
3027
|
+
/**
|
|
3028
|
+
* Data source filter
|
|
3029
|
+
*/
|
|
3030
|
+
'filters.dataSource'?: string;
|
|
3031
|
+
/**
|
|
3032
|
+
* Symbol filter
|
|
3033
|
+
*/
|
|
3034
|
+
'filters.symbol'?: string;
|
|
3035
|
+
/**
|
|
3036
|
+
* Tag filters
|
|
3037
|
+
*/
|
|
3038
|
+
'filters.tags'?: Array<string>;
|
|
3039
|
+
/**
|
|
3040
|
+
* Enable experimental features
|
|
3041
|
+
*/
|
|
3042
|
+
isExperimentalFeatures?: boolean;
|
|
3043
|
+
/**
|
|
3044
|
+
* Enable restricted view mode
|
|
3045
|
+
*/
|
|
3046
|
+
isRestrictedView?: boolean;
|
|
3047
|
+
/**
|
|
3048
|
+
* Language code
|
|
3049
|
+
*/
|
|
3050
|
+
language?: string;
|
|
3051
|
+
/**
|
|
3052
|
+
* Locale code
|
|
3053
|
+
*/
|
|
3054
|
+
locale?: string;
|
|
3055
|
+
/**
|
|
3056
|
+
* Projected total amount
|
|
3057
|
+
*/
|
|
3058
|
+
projectedTotalAmount?: number;
|
|
3059
|
+
/**
|
|
3060
|
+
* Retirement date in ISO 8601 format
|
|
3061
|
+
*/
|
|
3062
|
+
retirementDate?: string;
|
|
3063
|
+
/**
|
|
3064
|
+
* Savings rate percentage
|
|
3065
|
+
*/
|
|
3066
|
+
savingsRate?: number;
|
|
3067
|
+
/**
|
|
3068
|
+
* View mode
|
|
3069
|
+
*/
|
|
3070
|
+
viewMode?: 'DEFAULT' | 'ZEN';
|
|
3071
|
+
};
|
|
3072
|
+
|
|
3073
|
+
/**
|
|
3074
|
+
* Color scheme
|
|
3075
|
+
*/
|
|
3076
|
+
export type colorScheme = 'DARK' | 'LIGHT';
|
|
3077
|
+
|
|
3078
|
+
/**
|
|
3079
|
+
* View mode
|
|
3080
|
+
*/
|
|
3081
|
+
export type viewMode = 'DEFAULT' | 'ZEN';
|
|
3082
|
+
|
|
3083
|
+
export type UpdatePropertyDto = {
|
|
3084
|
+
/**
|
|
3085
|
+
* Property value
|
|
3086
|
+
*/
|
|
3087
|
+
value: string;
|
|
3088
|
+
};
|
|
3089
|
+
|
|
3090
|
+
export type CreateTransactionRuleDto = {
|
|
3091
|
+
name: string;
|
|
3092
|
+
description?: string;
|
|
3093
|
+
narrationKeywords?: Array<unknown[]>;
|
|
3094
|
+
payeeKeywords?: Array<unknown[]>;
|
|
3095
|
+
categoryKeywords?: Array<unknown[]>;
|
|
3096
|
+
/**
|
|
3097
|
+
* Payment method keywords (e.g., HuaBei, YuEBao)
|
|
3098
|
+
*/
|
|
3099
|
+
methodKeywords?: Array<unknown[]>;
|
|
3100
|
+
/**
|
|
3101
|
+
* Destination account for expenses/income (e.g., Expenses:Food:Coffee)
|
|
3102
|
+
*/
|
|
3103
|
+
categoryAccount?: string;
|
|
3104
|
+
matchLogic: 'OR' | 'AND';
|
|
3105
|
+
/**
|
|
3106
|
+
* Minimum transaction amount (inclusive)
|
|
3107
|
+
*/
|
|
3108
|
+
amountMin?: number;
|
|
3109
|
+
/**
|
|
3110
|
+
* Maximum transaction amount (inclusive)
|
|
3111
|
+
*/
|
|
3112
|
+
amountMax?: number;
|
|
3113
|
+
priority: number;
|
|
3114
|
+
additionalTags?: Array<unknown[]>;
|
|
3115
|
+
additionalMetadata?: {
|
|
3116
|
+
[key: string]: unknown;
|
|
3117
|
+
};
|
|
3118
|
+
/**
|
|
3119
|
+
* If true, update existing rule with matching payeeKeywords[0] instead of creating new rule
|
|
3120
|
+
*/
|
|
3121
|
+
upsertByPayee?: boolean;
|
|
3122
|
+
};
|
|
3123
|
+
|
|
3124
|
+
export type matchLogic = 'OR' | 'AND';
|
|
3125
|
+
|
|
3126
|
+
export type AmountRangeDto = {
|
|
3127
|
+
/**
|
|
3128
|
+
* Minimum amount
|
|
3129
|
+
*/
|
|
3130
|
+
min?: number;
|
|
3131
|
+
/**
|
|
3132
|
+
* Maximum amount
|
|
3133
|
+
*/
|
|
3134
|
+
max?: number;
|
|
3135
|
+
};
|
|
3136
|
+
|
|
3137
|
+
export type TransactionRuleResponseDto = {
|
|
3138
|
+
/**
|
|
3139
|
+
* Rule ID
|
|
3140
|
+
*/
|
|
3141
|
+
id: string;
|
|
3142
|
+
/**
|
|
3143
|
+
* Rule name
|
|
3144
|
+
*/
|
|
3145
|
+
name: string;
|
|
3146
|
+
/**
|
|
3147
|
+
* Rule description
|
|
2617
3148
|
*/
|
|
2618
3149
|
description?: string;
|
|
2619
3150
|
/**
|
|
@@ -2857,176 +3388,58 @@ export type UpdateTransactionRuleDto = {
|
|
|
2857
3388
|
/**
|
|
2858
3389
|
* Payment method keywords (e.g., HuaBei, YuEBao)
|
|
2859
3390
|
*/
|
|
2860
|
-
methodKeywords?: Array<unknown[]>;
|
|
2861
|
-
/**
|
|
2862
|
-
* Destination account for expenses/income (e.g., Expenses:Food:Coffee)
|
|
2863
|
-
*/
|
|
2864
|
-
categoryAccount?: string;
|
|
2865
|
-
matchLogic?: 'OR' | 'AND';
|
|
2866
|
-
/**
|
|
2867
|
-
* Minimum transaction amount (inclusive)
|
|
2868
|
-
*/
|
|
2869
|
-
amountMin?: number;
|
|
2870
|
-
/**
|
|
2871
|
-
* Maximum transaction amount (inclusive)
|
|
2872
|
-
*/
|
|
2873
|
-
amountMax?: number;
|
|
2874
|
-
priority?: number;
|
|
2875
|
-
/**
|
|
2876
|
-
* Enable or disable the rule
|
|
2877
|
-
*/
|
|
2878
|
-
enabled?: boolean;
|
|
2879
|
-
additionalTags?: Array<unknown[]>;
|
|
2880
|
-
additionalMetadata?: {
|
|
2881
|
-
[key: string]: unknown;
|
|
2882
|
-
};
|
|
2883
|
-
};
|
|
2884
|
-
|
|
2885
|
-
export type TestRuleDto = {
|
|
2886
|
-
narration: string;
|
|
2887
|
-
payee?: string;
|
|
2888
|
-
categoryAccount?: string;
|
|
2889
|
-
amount?: number;
|
|
2890
|
-
currency?: string;
|
|
2891
|
-
};
|
|
2892
|
-
|
|
2893
|
-
export type TestRuleResponseDto = {
|
|
2894
|
-
/**
|
|
2895
|
-
* Rule ID that was tested
|
|
2896
|
-
*/
|
|
2897
|
-
ruleId: string;
|
|
2898
|
-
/**
|
|
2899
|
-
* Whether the rule matched the test data
|
|
2900
|
-
*/
|
|
2901
|
-
matches: boolean;
|
|
2902
|
-
/**
|
|
2903
|
-
* Match confidence score (0-1)
|
|
2904
|
-
*/
|
|
2905
|
-
confidence: number;
|
|
2906
|
-
/**
|
|
2907
|
-
* Details of which fields matched
|
|
2908
|
-
*/
|
|
2909
|
-
matchDetails: {
|
|
2910
|
-
[key: string]: unknown;
|
|
2911
|
-
};
|
|
2912
|
-
};
|
|
2913
|
-
|
|
2914
|
-
export type DeleteOwnUserDto = {
|
|
2915
|
-
/**
|
|
2916
|
-
* Access token for user verification
|
|
2917
|
-
*/
|
|
2918
|
-
accessToken: string;
|
|
2919
|
-
};
|
|
2920
|
-
|
|
2921
|
-
export type SignupDto = {
|
|
2922
|
-
/**
|
|
2923
|
-
* Cloudflare Turnstile verification token (optional when Turnstile disabled)
|
|
2924
|
-
*/
|
|
2925
|
-
turnstileToken?: string;
|
|
2926
|
-
};
|
|
2927
|
-
|
|
2928
|
-
export type UpdateUserSettingDto = {
|
|
2929
|
-
/**
|
|
2930
|
-
* Security ID
|
|
2931
|
-
*/
|
|
2932
|
-
secId?: number;
|
|
2933
|
-
/**
|
|
2934
|
-
* Annual interest rate
|
|
2935
|
-
*/
|
|
2936
|
-
annualInterestRate?: number;
|
|
2937
|
-
/**
|
|
2938
|
-
* Currency code
|
|
2939
|
-
*/
|
|
2940
|
-
currency?: string;
|
|
2941
|
-
/**
|
|
2942
|
-
* Base currency code
|
|
2943
|
-
*/
|
|
2944
|
-
baseCurrency?: string;
|
|
2945
|
-
/**
|
|
2946
|
-
* Benchmark symbol
|
|
2947
|
-
*/
|
|
2948
|
-
benchmark?: string;
|
|
2949
|
-
/**
|
|
2950
|
-
* Color scheme
|
|
2951
|
-
*/
|
|
2952
|
-
colorScheme?: 'DARK' | 'LIGHT';
|
|
2953
|
-
/**
|
|
2954
|
-
* Date range filter
|
|
2955
|
-
*/
|
|
2956
|
-
dateRange?: string;
|
|
2957
|
-
/**
|
|
2958
|
-
* Emergency fund amount
|
|
2959
|
-
*/
|
|
2960
|
-
emergencyFund?: number;
|
|
2961
|
-
/**
|
|
2962
|
-
* Account filter IDs
|
|
2963
|
-
*/
|
|
2964
|
-
'filters.accounts'?: Array<string>;
|
|
2965
|
-
/**
|
|
2966
|
-
* Asset class filters
|
|
2967
|
-
*/
|
|
2968
|
-
'filters.assetClasses'?: Array<string>;
|
|
2969
|
-
/**
|
|
2970
|
-
* Data source filter
|
|
2971
|
-
*/
|
|
2972
|
-
'filters.dataSource'?: string;
|
|
2973
|
-
/**
|
|
2974
|
-
* Symbol filter
|
|
2975
|
-
*/
|
|
2976
|
-
'filters.symbol'?: string;
|
|
2977
|
-
/**
|
|
2978
|
-
* Tag filters
|
|
2979
|
-
*/
|
|
2980
|
-
'filters.tags'?: Array<string>;
|
|
2981
|
-
/**
|
|
2982
|
-
* Enable experimental features
|
|
2983
|
-
*/
|
|
2984
|
-
isExperimentalFeatures?: boolean;
|
|
3391
|
+
methodKeywords?: Array<unknown[]>;
|
|
2985
3392
|
/**
|
|
2986
|
-
*
|
|
3393
|
+
* Destination account for expenses/income (e.g., Expenses:Food:Coffee)
|
|
2987
3394
|
*/
|
|
2988
|
-
|
|
3395
|
+
categoryAccount?: string;
|
|
3396
|
+
matchLogic?: 'OR' | 'AND';
|
|
2989
3397
|
/**
|
|
2990
|
-
*
|
|
3398
|
+
* Minimum transaction amount (inclusive)
|
|
2991
3399
|
*/
|
|
2992
|
-
|
|
3400
|
+
amountMin?: number;
|
|
2993
3401
|
/**
|
|
2994
|
-
*
|
|
3402
|
+
* Maximum transaction amount (inclusive)
|
|
2995
3403
|
*/
|
|
2996
|
-
|
|
3404
|
+
amountMax?: number;
|
|
3405
|
+
priority?: number;
|
|
2997
3406
|
/**
|
|
2998
|
-
*
|
|
3407
|
+
* Enable or disable the rule
|
|
2999
3408
|
*/
|
|
3000
|
-
|
|
3409
|
+
enabled?: boolean;
|
|
3410
|
+
additionalTags?: Array<unknown[]>;
|
|
3411
|
+
additionalMetadata?: {
|
|
3412
|
+
[key: string]: unknown;
|
|
3413
|
+
};
|
|
3414
|
+
};
|
|
3415
|
+
|
|
3416
|
+
export type TestRuleDto = {
|
|
3417
|
+
narration: string;
|
|
3418
|
+
payee?: string;
|
|
3419
|
+
categoryAccount?: string;
|
|
3420
|
+
amount?: number;
|
|
3421
|
+
currency?: string;
|
|
3422
|
+
};
|
|
3423
|
+
|
|
3424
|
+
export type TestRuleResponseDto = {
|
|
3001
3425
|
/**
|
|
3002
|
-
*
|
|
3426
|
+
* Rule ID that was tested
|
|
3003
3427
|
*/
|
|
3004
|
-
|
|
3428
|
+
ruleId: string;
|
|
3005
3429
|
/**
|
|
3006
|
-
*
|
|
3430
|
+
* Whether the rule matched the test data
|
|
3007
3431
|
*/
|
|
3008
|
-
|
|
3432
|
+
matches: boolean;
|
|
3009
3433
|
/**
|
|
3010
|
-
*
|
|
3434
|
+
* Match confidence score (0-1)
|
|
3011
3435
|
*/
|
|
3012
|
-
|
|
3013
|
-
};
|
|
3014
|
-
|
|
3015
|
-
/**
|
|
3016
|
-
* Color scheme
|
|
3017
|
-
*/
|
|
3018
|
-
export type colorScheme = 'DARK' | 'LIGHT';
|
|
3019
|
-
|
|
3020
|
-
/**
|
|
3021
|
-
* View mode
|
|
3022
|
-
*/
|
|
3023
|
-
export type viewMode = 'DEFAULT' | 'ZEN';
|
|
3024
|
-
|
|
3025
|
-
export type UpdatePropertyDto = {
|
|
3436
|
+
confidence: number;
|
|
3026
3437
|
/**
|
|
3027
|
-
*
|
|
3438
|
+
* Details of which fields matched
|
|
3028
3439
|
*/
|
|
3029
|
-
|
|
3440
|
+
matchDetails: {
|
|
3441
|
+
[key: string]: unknown;
|
|
3442
|
+
};
|
|
3030
3443
|
};
|
|
3031
3444
|
|
|
3032
3445
|
export type CreateBeanEventDto = {
|
|
@@ -3119,6 +3532,160 @@ export type UpdateBeanEventDto = {
|
|
|
3119
3532
|
};
|
|
3120
3533
|
};
|
|
3121
3534
|
|
|
3535
|
+
export type OnboardingAccountDto = {
|
|
3536
|
+
/**
|
|
3537
|
+
* Account path (Assets/Liabilities only; format validated by the account service)
|
|
3538
|
+
*/
|
|
3539
|
+
path: string;
|
|
3540
|
+
/**
|
|
3541
|
+
* ISO 4217 currency code (3 letters)
|
|
3542
|
+
*/
|
|
3543
|
+
currency: string;
|
|
3544
|
+
/**
|
|
3545
|
+
* Opening balance as a non-negative Decimal string (e.g. "1000.00")
|
|
3546
|
+
*/
|
|
3547
|
+
openingBalance?: string;
|
|
3548
|
+
/**
|
|
3549
|
+
* Platform ID to bind the account to (references Platform.id); omit for unbound
|
|
3550
|
+
*/
|
|
3551
|
+
platformId?: string;
|
|
3552
|
+
};
|
|
3553
|
+
|
|
3554
|
+
export type OnboardingDto = {
|
|
3555
|
+
/**
|
|
3556
|
+
* Asset/Liability accounts to register with opening balances
|
|
3557
|
+
*/
|
|
3558
|
+
accounts?: Array<OnboardingAccountDto>;
|
|
3559
|
+
/**
|
|
3560
|
+
* Skip asset registration; only bootstrap the core account set
|
|
3561
|
+
*/
|
|
3562
|
+
skipAssetRegistration?: boolean;
|
|
3563
|
+
};
|
|
3564
|
+
|
|
3565
|
+
export type ActualBalanceDto = {
|
|
3566
|
+
/**
|
|
3567
|
+
* Actual balance amount as a decimal string (preserves precision for tolerance inference).
|
|
3568
|
+
*/
|
|
3569
|
+
amount: string;
|
|
3570
|
+
/**
|
|
3571
|
+
* Currency code (ISO 4217 or commodity ticker).
|
|
3572
|
+
*/
|
|
3573
|
+
ccy: string;
|
|
3574
|
+
};
|
|
3575
|
+
|
|
3576
|
+
export type ComputeReconciliationDto = {
|
|
3577
|
+
/**
|
|
3578
|
+
* BeanAccount id to reconcile.
|
|
3579
|
+
*/
|
|
3580
|
+
accountId: string;
|
|
3581
|
+
/**
|
|
3582
|
+
* Assertion date (ISO 8601, e.g. "2026-07-24").
|
|
3583
|
+
*/
|
|
3584
|
+
asOfDate: string;
|
|
3585
|
+
/**
|
|
3586
|
+
* Actual balance from the external statement.
|
|
3587
|
+
*/
|
|
3588
|
+
actualBalance: ActualBalanceDto;
|
|
3589
|
+
};
|
|
3590
|
+
|
|
3591
|
+
export type ReconciliationComputeResultDto = {
|
|
3592
|
+
accountId: string;
|
|
3593
|
+
asOfDate: string;
|
|
3594
|
+
/**
|
|
3595
|
+
* System-computed book balance (decimal string).
|
|
3596
|
+
*/
|
|
3597
|
+
bookBalance: string;
|
|
3598
|
+
/**
|
|
3599
|
+
* User-entered actual balance (decimal string).
|
|
3600
|
+
*/
|
|
3601
|
+
actualBalance: string;
|
|
3602
|
+
currency: string;
|
|
3603
|
+
/**
|
|
3604
|
+
* Diff = book − actual (decimal string).
|
|
3605
|
+
*/
|
|
3606
|
+
diff: string;
|
|
3607
|
+
/**
|
|
3608
|
+
* Applied tolerance (decimal string).
|
|
3609
|
+
*/
|
|
3610
|
+
tolerance: string;
|
|
3611
|
+
/**
|
|
3612
|
+
* true when |diff| ≤ tolerance.
|
|
3613
|
+
*/
|
|
3614
|
+
withinTolerance: boolean;
|
|
3615
|
+
/**
|
|
3616
|
+
* Suggested next action: assert when within tolerance, pad otherwise.
|
|
3617
|
+
*/
|
|
3618
|
+
suggestedAction: 'assert' | 'pad';
|
|
3619
|
+
};
|
|
3620
|
+
|
|
3621
|
+
/**
|
|
3622
|
+
* Suggested next action: assert when within tolerance, pad otherwise.
|
|
3623
|
+
*/
|
|
3624
|
+
export type suggestedAction = 'assert' | 'pad';
|
|
3625
|
+
|
|
3626
|
+
export type AssertReconciliationDto = {
|
|
3627
|
+
/**
|
|
3628
|
+
* BeanAccount id to reconcile.
|
|
3629
|
+
*/
|
|
3630
|
+
accountId: string;
|
|
3631
|
+
/**
|
|
3632
|
+
* Assertion date (ISO 8601, e.g. "2026-07-24").
|
|
3633
|
+
*/
|
|
3634
|
+
asOfDate: string;
|
|
3635
|
+
/**
|
|
3636
|
+
* Actual balance from the external statement.
|
|
3637
|
+
*/
|
|
3638
|
+
actualBalance: ActualBalanceDto;
|
|
3639
|
+
/**
|
|
3640
|
+
* Optional explicit tolerance override. Omit to infer from amount precision (Beancount default).
|
|
3641
|
+
*/
|
|
3642
|
+
tolerance?: string;
|
|
3643
|
+
};
|
|
3644
|
+
|
|
3645
|
+
export type ReconciliationRecordDto = {
|
|
3646
|
+
id: string;
|
|
3647
|
+
accountId: string;
|
|
3648
|
+
date: string;
|
|
3649
|
+
/**
|
|
3650
|
+
* Asserted (actual) amount.
|
|
3651
|
+
*/
|
|
3652
|
+
amount: string;
|
|
3653
|
+
currency: string;
|
|
3654
|
+
tolerance?: string;
|
|
3655
|
+
/**
|
|
3656
|
+
* book − actual.
|
|
3657
|
+
*/
|
|
3658
|
+
diffAmount?: string;
|
|
3659
|
+
diffCurrency?: string;
|
|
3660
|
+
createdAt: string;
|
|
3661
|
+
};
|
|
3662
|
+
|
|
3663
|
+
export type PadReconciliationDto = {
|
|
3664
|
+
/**
|
|
3665
|
+
* BeanAccount id to reconcile.
|
|
3666
|
+
*/
|
|
3667
|
+
accountId: string;
|
|
3668
|
+
/**
|
|
3669
|
+
* Assertion date (ISO 8601, e.g. "2026-07-24").
|
|
3670
|
+
*/
|
|
3671
|
+
asOfDate: string;
|
|
3672
|
+
/**
|
|
3673
|
+
* Actual balance from the external statement.
|
|
3674
|
+
*/
|
|
3675
|
+
actualBalance: ActualBalanceDto;
|
|
3676
|
+
/**
|
|
3677
|
+
* Pad source account. Defaults to Equity:Opening-Balances (official Beancount convention).
|
|
3678
|
+
*/
|
|
3679
|
+
sourceAccount?: string;
|
|
3680
|
+
};
|
|
3681
|
+
|
|
3682
|
+
export type PadResultDto = {
|
|
3683
|
+
/**
|
|
3684
|
+
* Created pad adjusting transaction id.
|
|
3685
|
+
*/
|
|
3686
|
+
transactionId: string;
|
|
3687
|
+
};
|
|
3688
|
+
|
|
3122
3689
|
export type FileImportDto = {
|
|
3123
3690
|
/**
|
|
3124
3691
|
* Bill file to import (CSV, PDF, OFX, etc.)
|
|
@@ -3374,135 +3941,47 @@ export type importerId =
|
|
|
3374
3941
|
| 'cmbc'
|
|
3375
3942
|
| 'cmbc-credit'
|
|
3376
3943
|
| 'icbc'
|
|
3377
|
-
| 'icbc-credit'
|
|
3378
|
-
| 'hsbc-hk-credit'
|
|
3379
|
-
| 'hsbc-hk-debit';
|
|
3380
|
-
|
|
3381
|
-
export type UpdateMapperDefaultsDto = {
|
|
3382
|
-
/**
|
|
3383
|
-
* Source account for transactions (Beancount format)
|
|
3384
|
-
*/
|
|
3385
|
-
sourceAccount?: string;
|
|
3386
|
-
/**
|
|
3387
|
-
* Default currency (ISO 4217 code)
|
|
3388
|
-
*/
|
|
3389
|
-
currency?: string;
|
|
3390
|
-
/**
|
|
3391
|
-
* Default expense account (optional)
|
|
3392
|
-
*/
|
|
3393
|
-
expenseAccount?: string;
|
|
3394
|
-
/**
|
|
3395
|
-
* Default income account (optional)
|
|
3396
|
-
*/
|
|
3397
|
-
incomeAccount?: string;
|
|
3398
|
-
/**
|
|
3399
|
-
* Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).
|
|
3400
|
-
*/
|
|
3401
|
-
methodAccountMapping?: {
|
|
3402
|
-
[key: string]: unknown;
|
|
3403
|
-
};
|
|
3404
|
-
};
|
|
3405
|
-
|
|
3406
|
-
export type UpdateConfigDataDto = {
|
|
3407
|
-
/**
|
|
3408
|
-
* Mapper defaults configuration
|
|
3409
|
-
*/
|
|
3410
|
-
defaults?: UpdateMapperDefaultsDto;
|
|
3411
|
-
};
|
|
3412
|
-
|
|
3413
|
-
export type UpdateImporterConfigDto = {
|
|
3414
|
-
/**
|
|
3415
|
-
* Configuration data (v1 schema)
|
|
3416
|
-
*/
|
|
3417
|
-
data?: UpdateConfigDataDto;
|
|
3418
|
-
};
|
|
3419
|
-
|
|
3420
|
-
export type CreatePlatformDto = {
|
|
3421
|
-
/**
|
|
3422
|
-
* Platform name
|
|
3423
|
-
*/
|
|
3424
|
-
name: string;
|
|
3425
|
-
/**
|
|
3426
|
-
* Platform canonical identifier (lowercase, kebab-case)
|
|
3427
|
-
*/
|
|
3428
|
-
canonical: string;
|
|
3429
|
-
/**
|
|
3430
|
-
* Platform aliases (multi-language names for lookup)
|
|
3431
|
-
*/
|
|
3432
|
-
aliases: Array<string>;
|
|
3433
|
-
/**
|
|
3434
|
-
* Platform URL
|
|
3435
|
-
*/
|
|
3436
|
-
url: string;
|
|
3437
|
-
/**
|
|
3438
|
-
* Platform type
|
|
3439
|
-
*/
|
|
3440
|
-
type:
|
|
3441
|
-
| 'BANK'
|
|
3442
|
-
| 'BROKERAGE'
|
|
3443
|
-
| 'CRYPTO_EXCHANGE'
|
|
3444
|
-
| 'PAYMENT'
|
|
3445
|
-
| 'INVESTMENT'
|
|
3446
|
-
| 'INSURANCE'
|
|
3447
|
-
| 'OTHER';
|
|
3448
|
-
/**
|
|
3449
|
-
* Platform logo URL
|
|
3450
|
-
*/
|
|
3451
|
-
logoUrl?: string;
|
|
3452
|
-
/**
|
|
3453
|
-
* Whether the platform is active
|
|
3454
|
-
*/
|
|
3455
|
-
isActive?: boolean;
|
|
3456
|
-
};
|
|
3457
|
-
|
|
3458
|
-
/**
|
|
3459
|
-
* Platform type
|
|
3460
|
-
*/
|
|
3461
|
-
export type type3 =
|
|
3462
|
-
| 'BANK'
|
|
3463
|
-
| 'BROKERAGE'
|
|
3464
|
-
| 'CRYPTO_EXCHANGE'
|
|
3465
|
-
| 'PAYMENT'
|
|
3466
|
-
| 'INVESTMENT'
|
|
3467
|
-
| 'INSURANCE'
|
|
3468
|
-
| 'OTHER';
|
|
3944
|
+
| 'icbc-credit'
|
|
3945
|
+
| 'hsbc-hk-credit'
|
|
3946
|
+
| 'hsbc-hk-debit';
|
|
3469
3947
|
|
|
3470
|
-
export type
|
|
3948
|
+
export type UpdateMapperDefaultsDto = {
|
|
3471
3949
|
/**
|
|
3472
|
-
*
|
|
3950
|
+
* Source account for transactions (Beancount format)
|
|
3473
3951
|
*/
|
|
3474
|
-
|
|
3952
|
+
sourceAccount?: string;
|
|
3475
3953
|
/**
|
|
3476
|
-
*
|
|
3954
|
+
* Default currency (ISO 4217 code)
|
|
3477
3955
|
*/
|
|
3478
|
-
|
|
3956
|
+
currency?: string;
|
|
3479
3957
|
/**
|
|
3480
|
-
*
|
|
3958
|
+
* Default expense account (optional)
|
|
3481
3959
|
*/
|
|
3482
|
-
|
|
3960
|
+
expenseAccount?: string;
|
|
3483
3961
|
/**
|
|
3484
|
-
*
|
|
3962
|
+
* Default income account (optional)
|
|
3485
3963
|
*/
|
|
3486
|
-
|
|
3964
|
+
incomeAccount?: string;
|
|
3487
3965
|
/**
|
|
3488
|
-
*
|
|
3966
|
+
* Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).
|
|
3489
3967
|
*/
|
|
3490
|
-
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
| 'INSURANCE'
|
|
3497
|
-
| 'OTHER';
|
|
3968
|
+
methodAccountMapping?: {
|
|
3969
|
+
[key: string]: unknown;
|
|
3970
|
+
};
|
|
3971
|
+
};
|
|
3972
|
+
|
|
3973
|
+
export type UpdateConfigDataDto = {
|
|
3498
3974
|
/**
|
|
3499
|
-
*
|
|
3975
|
+
* Mapper defaults configuration
|
|
3500
3976
|
*/
|
|
3501
|
-
|
|
3977
|
+
defaults?: UpdateMapperDefaultsDto;
|
|
3978
|
+
};
|
|
3979
|
+
|
|
3980
|
+
export type UpdateImporterConfigDto = {
|
|
3502
3981
|
/**
|
|
3503
|
-
*
|
|
3982
|
+
* Configuration data (v1 schema)
|
|
3504
3983
|
*/
|
|
3505
|
-
|
|
3984
|
+
data?: UpdateConfigDataDto;
|
|
3506
3985
|
};
|
|
3507
3986
|
|
|
3508
3987
|
export type ProviderSyncConfigDto = {
|
|
@@ -3526,6 +4005,10 @@ export type ProviderSyncConfigDto = {
|
|
|
3526
4005
|
* Filter pending transactions
|
|
3527
4006
|
*/
|
|
3528
4007
|
filterPending?: boolean;
|
|
4008
|
+
/**
|
|
4009
|
+
* External account ID for per-batch providers (e.g. GoCardless). Overrides sourceAccount when an ExternalAccountLink mapping exists.
|
|
4010
|
+
*/
|
|
4011
|
+
externalAccountId?: string;
|
|
3529
4012
|
};
|
|
3530
4013
|
|
|
3531
4014
|
export type ProviderSyncDto = {
|
|
@@ -3581,6 +4064,61 @@ export type SupportedProvidersResponseDto = {
|
|
|
3581
4064
|
providers: Array<string>;
|
|
3582
4065
|
};
|
|
3583
4066
|
|
|
4067
|
+
export type CreateExternalAccountLinkDto = {
|
|
4068
|
+
/**
|
|
4069
|
+
* Open Banking provider (whitelist)
|
|
4070
|
+
*/
|
|
4071
|
+
provider:
|
|
4072
|
+
| 'plaid'
|
|
4073
|
+
| 'teller'
|
|
4074
|
+
| 'truelayer'
|
|
4075
|
+
| 'gocardless'
|
|
4076
|
+
| 'simplefin'
|
|
4077
|
+
| 'yodlee'
|
|
4078
|
+
| 'beancount-direct'
|
|
4079
|
+
| 'parsed-bill';
|
|
4080
|
+
/**
|
|
4081
|
+
* External account ID from the provider
|
|
4082
|
+
*/
|
|
4083
|
+
externalAccountId: string;
|
|
4084
|
+
/**
|
|
4085
|
+
* Target BeanAccount ID (must belong to the JWT user)
|
|
4086
|
+
*/
|
|
4087
|
+
beanAccountId: string;
|
|
4088
|
+
};
|
|
4089
|
+
|
|
4090
|
+
/**
|
|
4091
|
+
* Open Banking provider (whitelist)
|
|
4092
|
+
*/
|
|
4093
|
+
export type provider =
|
|
4094
|
+
| 'plaid'
|
|
4095
|
+
| 'teller'
|
|
4096
|
+
| 'truelayer'
|
|
4097
|
+
| 'gocardless'
|
|
4098
|
+
| 'simplefin'
|
|
4099
|
+
| 'yodlee'
|
|
4100
|
+
| 'beancount-direct'
|
|
4101
|
+
| 'parsed-bill';
|
|
4102
|
+
|
|
4103
|
+
export type ExternalAccountLinkResponseDto = {
|
|
4104
|
+
id: string;
|
|
4105
|
+
provider: string;
|
|
4106
|
+
externalAccountId: string;
|
|
4107
|
+
beanAccountId: string;
|
|
4108
|
+
isActive: boolean;
|
|
4109
|
+
createdAt: string;
|
|
4110
|
+
updatedAt: string;
|
|
4111
|
+
};
|
|
4112
|
+
|
|
4113
|
+
export type ExternalAccountLinkListResponseDto = {
|
|
4114
|
+
items: Array<ExternalAccountLinkResponseDto>;
|
|
4115
|
+
total: number;
|
|
4116
|
+
/**
|
|
4117
|
+
* Filter by provider (query param)
|
|
4118
|
+
*/
|
|
4119
|
+
provider?: string;
|
|
4120
|
+
};
|
|
4121
|
+
|
|
3584
4122
|
export type ParserTelemetryReportDto = unknown;
|
|
3585
4123
|
|
|
3586
4124
|
export type UncoveredFormatMissDto = unknown;
|
|
@@ -3600,6 +4138,14 @@ export type ProcessNlpDto = {
|
|
|
3600
4138
|
parsedData?: {
|
|
3601
4139
|
[key: string]: unknown;
|
|
3602
4140
|
};
|
|
4141
|
+
/**
|
|
4142
|
+
* confirm_rule echo-back: rule id selected from the prior confirm_rule response (matchedRule.id or alternatives[i].ruleId). Applied directly when the session is confirming_rule — no NL re-parse.
|
|
4143
|
+
*/
|
|
4144
|
+
selectedRuleId?: string;
|
|
4145
|
+
/**
|
|
4146
|
+
* confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i], or a typed path). Applied directly when the session is confirming_account — no NL re-parse.
|
|
4147
|
+
*/
|
|
4148
|
+
selectedAccount?: string;
|
|
3603
4149
|
};
|
|
3604
4150
|
|
|
3605
4151
|
export type NlpTransactionInfoDto = {
|
|
@@ -3843,9 +4389,9 @@ export type NlpAccountConfirmationDataDto = {
|
|
|
3843
4389
|
*/
|
|
3844
4390
|
invalidAccount: string;
|
|
3845
4391
|
/**
|
|
3846
|
-
* Suggested replacement account
|
|
4392
|
+
* Suggested replacement account (omitted when no clear candidate)
|
|
3847
4393
|
*/
|
|
3848
|
-
suggestedAccount
|
|
4394
|
+
suggestedAccount?: string;
|
|
3849
4395
|
/**
|
|
3850
4396
|
* Similar accounts for user selection
|
|
3851
4397
|
*/
|
|
@@ -3973,7 +4519,7 @@ export type NlpSuggestedAccountDto = {
|
|
|
3973
4519
|
*/
|
|
3974
4520
|
account: string;
|
|
3975
4521
|
/**
|
|
3976
|
-
* Confidence score for this suggestion (0-1)
|
|
4522
|
+
* Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)
|
|
3977
4523
|
*/
|
|
3978
4524
|
confidence?: number;
|
|
3979
4525
|
};
|
|
@@ -3991,21 +4537,21 @@ export type NlpSuggestedAccountsDto = {
|
|
|
3991
4537
|
|
|
3992
4538
|
export type NlpDefaultAccountsDto = {
|
|
3993
4539
|
/**
|
|
3994
|
-
* Default asset account
|
|
4540
|
+
* Default OPEN asset account (MRU when multiple), or null when none/ambiguous
|
|
3995
4541
|
*/
|
|
3996
|
-
asset: string;
|
|
4542
|
+
asset: string | null;
|
|
3997
4543
|
/**
|
|
3998
|
-
* Default expense account
|
|
4544
|
+
* Default OPEN expense account (MRU when multiple), or null when none/ambiguous
|
|
3999
4545
|
*/
|
|
4000
|
-
expense: string;
|
|
4546
|
+
expense: string | null;
|
|
4001
4547
|
/**
|
|
4002
|
-
* Default income account
|
|
4548
|
+
* Default OPEN income account (MRU when multiple), or null when none/ambiguous
|
|
4003
4549
|
*/
|
|
4004
|
-
income: string;
|
|
4550
|
+
income: string | null;
|
|
4005
4551
|
/**
|
|
4006
|
-
* Default liability account
|
|
4552
|
+
* Default OPEN liability account (MRU when multiple), or null when none/ambiguous
|
|
4007
4553
|
*/
|
|
4008
|
-
liability: string;
|
|
4554
|
+
liability: string | null;
|
|
4009
4555
|
};
|
|
4010
4556
|
|
|
4011
4557
|
export type NlpResponseDto = {
|
|
@@ -4024,7 +4570,8 @@ export type NlpResponseDto = {
|
|
|
4024
4570
|
| 'confirm_rule'
|
|
4025
4571
|
| 'confirm_account'
|
|
4026
4572
|
| 'confirm_payee'
|
|
4027
|
-
| 'cancel'
|
|
4573
|
+
| 'cancel'
|
|
4574
|
+
| 'aborted';
|
|
4028
4575
|
/**
|
|
4029
4576
|
* Transaction intent detected by EntityRouter (v6.0: 5 core intents). Frontend uses this to render scenario-specific form fields.
|
|
4030
4577
|
*/
|
|
@@ -4113,11 +4660,11 @@ export type NlpResponseDto = {
|
|
|
4113
4660
|
*/
|
|
4114
4661
|
recurringSuggestion?: RecurringSuggestionDto;
|
|
4115
4662
|
/**
|
|
4116
|
-
* Suggested accounts for this transaction.
|
|
4663
|
+
* Suggested accounts for this transaction (#586). confirm/confirm_rule/confirm_account: predicted (source/destination carry confidence); created: actual persisted accounts (confidence omitted). confirm_account destination is the suggested replacement, never the invalid account.
|
|
4117
4664
|
*/
|
|
4118
4665
|
suggestedAccounts?: NlpSuggestedAccountsDto;
|
|
4119
4666
|
/**
|
|
4120
|
-
* Default accounts for the user/region.
|
|
4667
|
+
* Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.
|
|
4121
4668
|
*/
|
|
4122
4669
|
defaultAccounts?: NlpDefaultAccountsDto;
|
|
4123
4670
|
};
|
|
@@ -4138,7 +4685,8 @@ export type action2 =
|
|
|
4138
4685
|
| 'confirm_rule'
|
|
4139
4686
|
| 'confirm_account'
|
|
4140
4687
|
| 'confirm_payee'
|
|
4141
|
-
| 'cancel'
|
|
4688
|
+
| 'cancel'
|
|
4689
|
+
| 'aborted';
|
|
4142
4690
|
|
|
4143
4691
|
/**
|
|
4144
4692
|
* Transaction intent detected by EntityRouter (v6.0: 5 core intents). Frontend uses this to render scenario-specific form fields.
|
|
@@ -4160,15 +4708,201 @@ export type liabilitySubType = 'borrow' | 'repay';
|
|
|
4160
4708
|
*/
|
|
4161
4709
|
export type equitySubType = 'opening' | 'adjustment';
|
|
4162
4710
|
|
|
4163
|
-
export type
|
|
4711
|
+
export type PlatformListItemDto = {
|
|
4164
4712
|
/**
|
|
4165
|
-
*
|
|
4713
|
+
* Global platform ID
|
|
4166
4714
|
*/
|
|
4167
|
-
|
|
4715
|
+
id: string;
|
|
4168
4716
|
/**
|
|
4169
|
-
*
|
|
4717
|
+
* Platform name
|
|
4170
4718
|
*/
|
|
4171
|
-
|
|
4719
|
+
name: string;
|
|
4720
|
+
/**
|
|
4721
|
+
* Platform URL
|
|
4722
|
+
*/
|
|
4723
|
+
url: string;
|
|
4724
|
+
/**
|
|
4725
|
+
* Platform type
|
|
4726
|
+
*/
|
|
4727
|
+
type:
|
|
4728
|
+
| 'BANK'
|
|
4729
|
+
| 'BROKERAGE'
|
|
4730
|
+
| 'CRYPTO_EXCHANGE'
|
|
4731
|
+
| 'PAYMENT'
|
|
4732
|
+
| 'INVESTMENT'
|
|
4733
|
+
| 'INSURANCE'
|
|
4734
|
+
| 'OTHER';
|
|
4735
|
+
/**
|
|
4736
|
+
* Canonical identifier in ACCOUNT_RE format (e.g., "icbc")
|
|
4737
|
+
*/
|
|
4738
|
+
canonical: string;
|
|
4739
|
+
/**
|
|
4740
|
+
* Suggested path segment — canonical with first char uppercased (ACC_COMP_NAME_RE)
|
|
4741
|
+
*/
|
|
4742
|
+
suggestedSegment: string;
|
|
4743
|
+
/**
|
|
4744
|
+
* Logo URL
|
|
4745
|
+
*/
|
|
4746
|
+
logoUrl: string | null;
|
|
4747
|
+
/**
|
|
4748
|
+
* Whether user has accounts using this platform
|
|
4749
|
+
*/
|
|
4750
|
+
isBound: boolean;
|
|
4751
|
+
};
|
|
4752
|
+
|
|
4753
|
+
/**
|
|
4754
|
+
* Platform type
|
|
4755
|
+
*/
|
|
4756
|
+
export type type3 =
|
|
4757
|
+
| 'BANK'
|
|
4758
|
+
| 'BROKERAGE'
|
|
4759
|
+
| 'CRYPTO_EXCHANGE'
|
|
4760
|
+
| 'PAYMENT'
|
|
4761
|
+
| 'INVESTMENT'
|
|
4762
|
+
| 'INSURANCE'
|
|
4763
|
+
| 'OTHER';
|
|
4764
|
+
|
|
4765
|
+
export type PlatformMatchResultDto = {
|
|
4766
|
+
/**
|
|
4767
|
+
* Global platform ID
|
|
4768
|
+
*/
|
|
4769
|
+
id: string;
|
|
4770
|
+
/**
|
|
4771
|
+
* Platform name (e.g., "ICBC")
|
|
4772
|
+
*/
|
|
4773
|
+
name: string;
|
|
4774
|
+
/**
|
|
4775
|
+
* Canonical identifier in ACCOUNT_RE format (e.g., "icbc")
|
|
4776
|
+
*/
|
|
4777
|
+
canonical: string;
|
|
4778
|
+
/**
|
|
4779
|
+
* Platform type
|
|
4780
|
+
*/
|
|
4781
|
+
type:
|
|
4782
|
+
| 'BANK'
|
|
4783
|
+
| 'BROKERAGE'
|
|
4784
|
+
| 'CRYPTO_EXCHANGE'
|
|
4785
|
+
| 'PAYMENT'
|
|
4786
|
+
| 'INVESTMENT'
|
|
4787
|
+
| 'INSURANCE'
|
|
4788
|
+
| 'OTHER';
|
|
4789
|
+
/**
|
|
4790
|
+
* Suggested path segment — canonical, already in ACCOUNT_RE format
|
|
4791
|
+
*/
|
|
4792
|
+
suggestedSegment: string;
|
|
4793
|
+
/**
|
|
4794
|
+
* Logo URL
|
|
4795
|
+
*/
|
|
4796
|
+
logoUrl: string | null;
|
|
4797
|
+
/**
|
|
4798
|
+
* How this row matched: 'exact' > 'prefix' > 'substring'
|
|
4799
|
+
*/
|
|
4800
|
+
matchType: 'exact' | 'prefix' | 'substring';
|
|
4801
|
+
};
|
|
4802
|
+
|
|
4803
|
+
/**
|
|
4804
|
+
* How this row matched: 'exact' > 'prefix' > 'substring'
|
|
4805
|
+
*/
|
|
4806
|
+
export type matchType = 'exact' | 'prefix' | 'substring';
|
|
4807
|
+
|
|
4808
|
+
export type PlatformMatchResponseDto = {
|
|
4809
|
+
/**
|
|
4810
|
+
* Ranked matches, best tier first (at most 10 rows)
|
|
4811
|
+
*/
|
|
4812
|
+
platforms: Array<PlatformMatchResultDto>;
|
|
4813
|
+
/**
|
|
4814
|
+
* Overall match quality — top row's tier, or 'none' when no hits
|
|
4815
|
+
*/
|
|
4816
|
+
matchType: 'none' | 'exact' | 'prefix' | 'substring';
|
|
4817
|
+
/**
|
|
4818
|
+
* Total matches before LIMIT (truncation transparency)
|
|
4819
|
+
*/
|
|
4820
|
+
total: number;
|
|
4821
|
+
/**
|
|
4822
|
+
* true when total > platforms.length (more matches exist)
|
|
4823
|
+
*/
|
|
4824
|
+
hasMore: boolean;
|
|
4825
|
+
};
|
|
4826
|
+
|
|
4827
|
+
/**
|
|
4828
|
+
* Overall match quality — top row's tier, or 'none' when no hits
|
|
4829
|
+
*/
|
|
4830
|
+
export type matchType2 = 'none' | 'exact' | 'prefix' | 'substring';
|
|
4831
|
+
|
|
4832
|
+
export type CreatePlatformDto = {
|
|
4833
|
+
/**
|
|
4834
|
+
* Platform name
|
|
4835
|
+
*/
|
|
4836
|
+
name: string;
|
|
4837
|
+
/**
|
|
4838
|
+
* Platform canonical identifier (lowercase, kebab-case)
|
|
4839
|
+
*/
|
|
4840
|
+
canonical: string;
|
|
4841
|
+
/**
|
|
4842
|
+
* Platform aliases (multi-language names for lookup)
|
|
4843
|
+
*/
|
|
4844
|
+
aliases: Array<string>;
|
|
4845
|
+
/**
|
|
4846
|
+
* Platform URL
|
|
4847
|
+
*/
|
|
4848
|
+
url: string;
|
|
4849
|
+
/**
|
|
4850
|
+
* Platform type
|
|
4851
|
+
*/
|
|
4852
|
+
type:
|
|
4853
|
+
| 'BANK'
|
|
4854
|
+
| 'BROKERAGE'
|
|
4855
|
+
| 'CRYPTO_EXCHANGE'
|
|
4856
|
+
| 'PAYMENT'
|
|
4857
|
+
| 'INVESTMENT'
|
|
4858
|
+
| 'INSURANCE'
|
|
4859
|
+
| 'OTHER';
|
|
4860
|
+
/**
|
|
4861
|
+
* Platform logo URL
|
|
4862
|
+
*/
|
|
4863
|
+
logoUrl?: string;
|
|
4864
|
+
/**
|
|
4865
|
+
* Whether the platform is active
|
|
4866
|
+
*/
|
|
4867
|
+
isActive?: boolean;
|
|
4868
|
+
};
|
|
4869
|
+
|
|
4870
|
+
export type UpdatePlatformDto = {
|
|
4871
|
+
/**
|
|
4872
|
+
* Platform name
|
|
4873
|
+
*/
|
|
4874
|
+
name?: string;
|
|
4875
|
+
/**
|
|
4876
|
+
* Platform canonical identifier (lowercase, kebab-case)
|
|
4877
|
+
*/
|
|
4878
|
+
canonical?: string;
|
|
4879
|
+
/**
|
|
4880
|
+
* Platform aliases (multi-language names for lookup)
|
|
4881
|
+
*/
|
|
4882
|
+
aliases?: Array<string>;
|
|
4883
|
+
/**
|
|
4884
|
+
* Platform URL
|
|
4885
|
+
*/
|
|
4886
|
+
url?: string;
|
|
4887
|
+
/**
|
|
4888
|
+
* Platform type
|
|
4889
|
+
*/
|
|
4890
|
+
type?:
|
|
4891
|
+
| 'BANK'
|
|
4892
|
+
| 'BROKERAGE'
|
|
4893
|
+
| 'CRYPTO_EXCHANGE'
|
|
4894
|
+
| 'PAYMENT'
|
|
4895
|
+
| 'INVESTMENT'
|
|
4896
|
+
| 'INSURANCE'
|
|
4897
|
+
| 'OTHER';
|
|
4898
|
+
/**
|
|
4899
|
+
* Platform logo URL
|
|
4900
|
+
*/
|
|
4901
|
+
logoUrl?: string;
|
|
4902
|
+
/**
|
|
4903
|
+
* Whether the platform is active
|
|
4904
|
+
*/
|
|
4905
|
+
isActive?: boolean;
|
|
4172
4906
|
};
|
|
4173
4907
|
|
|
4174
4908
|
export type NetWorthByCurrencyDto = {
|
|
@@ -4211,21 +4945,6 @@ export type ConvertedNetWorthDto = {
|
|
|
4211
4945
|
};
|
|
4212
4946
|
};
|
|
4213
4947
|
|
|
4214
|
-
export type ExchangeRateWarningDto = {
|
|
4215
|
-
/**
|
|
4216
|
-
* Warning type
|
|
4217
|
-
*/
|
|
4218
|
-
type: string;
|
|
4219
|
-
/**
|
|
4220
|
-
* Currency without exchange rate
|
|
4221
|
-
*/
|
|
4222
|
-
currency: string;
|
|
4223
|
-
/**
|
|
4224
|
-
* Total amount affected
|
|
4225
|
-
*/
|
|
4226
|
-
totalAmount: string;
|
|
4227
|
-
};
|
|
4228
|
-
|
|
4229
4948
|
export type NetWorthResponseDto = {
|
|
4230
4949
|
/**
|
|
4231
4950
|
* Total net worth (assets - liabilities, converted to base currency)
|
|
@@ -4290,6 +5009,10 @@ export type AccountItemDto = {
|
|
|
4290
5009
|
* Currency code
|
|
4291
5010
|
*/
|
|
4292
5011
|
currency: string;
|
|
5012
|
+
/**
|
|
5013
|
+
* FX-converted balance in base currency; omitted when not convertible
|
|
5014
|
+
*/
|
|
5015
|
+
convertedBalance?: string;
|
|
4293
5016
|
};
|
|
4294
5017
|
|
|
4295
5018
|
export type PlatformGroupDto = {
|
|
@@ -4393,6 +5116,10 @@ export type AccountItemWithAssetClassDto = {
|
|
|
4393
5116
|
* Currency code
|
|
4394
5117
|
*/
|
|
4395
5118
|
currency: string;
|
|
5119
|
+
/**
|
|
5120
|
+
* FX-converted balance in base currency; omitted when not convertible
|
|
5121
|
+
*/
|
|
5122
|
+
convertedBalance?: string;
|
|
4396
5123
|
/**
|
|
4397
5124
|
* Asset class
|
|
4398
5125
|
*/
|
|
@@ -4891,287 +5618,146 @@ export type HoldingPnlResponseDto = {
|
|
|
4891
5618
|
*/
|
|
4892
5619
|
export type method = 'average' | 'FIFO';
|
|
4893
5620
|
|
|
4894
|
-
export type
|
|
4895
|
-
/**
|
|
4896
|
-
* Currency being priced (e.g., USD, AAPL, BTC)
|
|
4897
|
-
*/
|
|
4898
|
-
currency: string;
|
|
4899
|
-
/**
|
|
4900
|
-
* Quote currency (pricing currency, e.g., CNY, EUR)
|
|
4901
|
-
*/
|
|
4902
|
-
quoteCurrency: string;
|
|
4903
|
-
/**
|
|
4904
|
-
* Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.
|
|
4905
|
-
*/
|
|
4906
|
-
amount: number;
|
|
4907
|
-
/**
|
|
4908
|
-
* Price date (ISO 8601 format)
|
|
4909
|
-
*/
|
|
4910
|
-
date: string;
|
|
4911
|
-
/**
|
|
4912
|
-
* Metadata (validated by Zod schema, max field lengths enforced)
|
|
4913
|
-
*/
|
|
4914
|
-
metadata?: {
|
|
4915
|
-
[key: string]: unknown;
|
|
4916
|
-
};
|
|
4917
|
-
};
|
|
4918
|
-
|
|
4919
|
-
export type PriceResponseDto = {
|
|
4920
|
-
/**
|
|
4921
|
-
* Unique identifier
|
|
4922
|
-
*/
|
|
4923
|
-
id: string;
|
|
4924
|
-
/**
|
|
4925
|
-
* User ID (owner of the price)
|
|
4926
|
-
*/
|
|
4927
|
-
userId: string;
|
|
4928
|
-
/**
|
|
4929
|
-
* Currency being priced (e.g., USD, AAPL, BTC)
|
|
4930
|
-
*/
|
|
4931
|
-
currency: string;
|
|
4932
|
-
/**
|
|
4933
|
-
* Quote currency (pricing currency, e.g., USD, CNY)
|
|
4934
|
-
*/
|
|
4935
|
-
quoteCurrency: string;
|
|
4936
|
-
/**
|
|
4937
|
-
* Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.
|
|
4938
|
-
*/
|
|
4939
|
-
amount: number;
|
|
4940
|
-
/**
|
|
4941
|
-
* Price date (ISO 8601 format). Represents the date this price was valid.
|
|
4942
|
-
*/
|
|
4943
|
-
date: string;
|
|
4944
|
-
/**
|
|
4945
|
-
* Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.
|
|
4946
|
-
*/
|
|
4947
|
-
meta: {
|
|
4948
|
-
[key: string]: unknown;
|
|
4949
|
-
};
|
|
4950
|
-
/**
|
|
4951
|
-
* Creation timestamp
|
|
4952
|
-
*/
|
|
4953
|
-
createdAt: string;
|
|
5621
|
+
export type AnonymousLoginDto = {
|
|
4954
5622
|
/**
|
|
4955
|
-
*
|
|
5623
|
+
* Access token for anonymous login
|
|
4956
5624
|
*/
|
|
4957
|
-
|
|
5625
|
+
accessToken: string;
|
|
4958
5626
|
};
|
|
4959
5627
|
|
|
4960
|
-
export type
|
|
4961
|
-
/**
|
|
4962
|
-
* List of prices
|
|
4963
|
-
*/
|
|
4964
|
-
items: Array<PriceResponseDto>;
|
|
5628
|
+
export type AnonymousLoginResponseDto = {
|
|
4965
5629
|
/**
|
|
4966
|
-
*
|
|
5630
|
+
* JWT auth token
|
|
4967
5631
|
*/
|
|
4968
|
-
|
|
5632
|
+
authToken: string;
|
|
4969
5633
|
};
|
|
4970
5634
|
|
|
4971
|
-
export type
|
|
4972
|
-
|
|
4973
|
-
|
|
4974
|
-
*/
|
|
4975
|
-
currency?: string;
|
|
4976
|
-
/**
|
|
4977
|
-
* Quote currency (pricing currency)
|
|
4978
|
-
*/
|
|
4979
|
-
quoteCurrency?: string;
|
|
4980
|
-
/**
|
|
4981
|
-
* Price amount (MUST be >= 0 per Beancount spec)
|
|
4982
|
-
*/
|
|
4983
|
-
amount?: number;
|
|
4984
|
-
/**
|
|
4985
|
-
* Price date (ISO 8601 format)
|
|
4986
|
-
*/
|
|
4987
|
-
date?: string;
|
|
4988
|
-
/**
|
|
4989
|
-
* Metadata
|
|
4990
|
-
*/
|
|
4991
|
-
metadata?: {
|
|
5635
|
+
export type SymbolSearchResultDto = {
|
|
5636
|
+
symbol: string;
|
|
5637
|
+
name?: {
|
|
4992
5638
|
[key: string]: unknown;
|
|
4993
|
-
};
|
|
4994
|
-
|
|
4995
|
-
|
|
4996
|
-
export type CurrencyBalanceDto = {
|
|
4997
|
-
/**
|
|
4998
|
-
* ISO 4217 currency code
|
|
4999
|
-
*/
|
|
5000
|
-
currency: string;
|
|
5001
|
-
/**
|
|
5002
|
-
* Balance amount
|
|
5003
|
-
*/
|
|
5004
|
-
balance: string;
|
|
5005
|
-
};
|
|
5006
|
-
|
|
5007
|
-
export type TimeSeriesPointDto = {
|
|
5008
|
-
/**
|
|
5009
|
-
* Date in YYYY-MM-DD format
|
|
5010
|
-
*/
|
|
5011
|
-
date: string;
|
|
5012
|
-
/**
|
|
5013
|
-
* Value at this date (in base currency)
|
|
5014
|
-
*/
|
|
5015
|
-
value: string;
|
|
5016
|
-
/**
|
|
5017
|
-
* Change from previous point
|
|
5018
|
-
*/
|
|
5019
|
-
change?: {
|
|
5639
|
+
} | null;
|
|
5640
|
+
exchange?: {
|
|
5020
5641
|
[key: string]: unknown;
|
|
5021
|
-
};
|
|
5022
|
-
/**
|
|
5023
|
-
* Total assets at this date (in base currency)
|
|
5024
|
-
*/
|
|
5025
|
-
assets?: string;
|
|
5026
|
-
/**
|
|
5027
|
-
* Total liabilities at this date (in base currency)
|
|
5028
|
-
*/
|
|
5029
|
-
liabilities?: string;
|
|
5030
|
-
/**
|
|
5031
|
-
* Multi-currency breakdown for this point
|
|
5032
|
-
*/
|
|
5033
|
-
byCurrency?: Array<CurrencyBalanceDto>;
|
|
5034
|
-
};
|
|
5035
|
-
|
|
5036
|
-
export type TrendSummaryDto = {
|
|
5037
|
-
/**
|
|
5038
|
-
* Value at start of period
|
|
5039
|
-
*/
|
|
5040
|
-
startValue: string;
|
|
5041
|
-
/**
|
|
5042
|
-
* Value at end of period
|
|
5043
|
-
*/
|
|
5044
|
-
endValue: string;
|
|
5045
|
-
/**
|
|
5046
|
-
* Total change over period
|
|
5047
|
-
*/
|
|
5048
|
-
totalChange: string;
|
|
5049
|
-
/**
|
|
5050
|
-
* Total change percentage
|
|
5051
|
-
*/
|
|
5052
|
-
totalChangePercentage: string;
|
|
5053
|
-
};
|
|
5054
|
-
|
|
5055
|
-
export type MultiCurrencyPointDto = {
|
|
5056
|
-
/**
|
|
5057
|
-
* Date in YYYY-MM-DD format
|
|
5058
|
-
*/
|
|
5059
|
-
date: string;
|
|
5060
|
-
/**
|
|
5061
|
-
* Balances by currency
|
|
5062
|
-
*/
|
|
5063
|
-
byCurrency: Array<CurrencyBalanceDto>;
|
|
5064
|
-
};
|
|
5065
|
-
|
|
5066
|
-
export type PortfolioTrendsResponseDto = {
|
|
5067
|
-
/**
|
|
5068
|
-
* Time series data points
|
|
5069
|
-
*/
|
|
5070
|
-
series: Array<TimeSeriesPointDto>;
|
|
5071
|
-
/**
|
|
5072
|
-
* Period summary
|
|
5073
|
-
*/
|
|
5074
|
-
summary: TrendSummaryDto;
|
|
5075
|
-
/**
|
|
5076
|
-
* Period requested
|
|
5077
|
-
*/
|
|
5078
|
-
period: string;
|
|
5642
|
+
} | null;
|
|
5079
5643
|
/**
|
|
5080
|
-
*
|
|
5644
|
+
* OpenBB asset_type (e.g. stock, etf)
|
|
5081
5645
|
*/
|
|
5082
|
-
|
|
5646
|
+
assetType?: {
|
|
5647
|
+
[key: string]: unknown;
|
|
5648
|
+
} | null;
|
|
5083
5649
|
/**
|
|
5084
|
-
*
|
|
5650
|
+
* IGN asset class (region.types.ts ASSET_CLASSES)
|
|
5085
5651
|
*/
|
|
5086
|
-
|
|
5652
|
+
assetClass?: {
|
|
5653
|
+
[key: string]: unknown;
|
|
5654
|
+
} | null;
|
|
5087
5655
|
/**
|
|
5088
|
-
*
|
|
5656
|
+
* IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)
|
|
5089
5657
|
*/
|
|
5090
|
-
|
|
5658
|
+
assetSubClass?: {
|
|
5659
|
+
[key: string]: unknown;
|
|
5660
|
+
} | null;
|
|
5091
5661
|
/**
|
|
5092
|
-
*
|
|
5662
|
+
* Trading currency (extra_data or inferred from exchange)
|
|
5093
5663
|
*/
|
|
5094
|
-
|
|
5664
|
+
currency?: {
|
|
5665
|
+
[key: string]: unknown;
|
|
5666
|
+
} | null;
|
|
5095
5667
|
};
|
|
5096
5668
|
|
|
5097
|
-
export type
|
|
5098
|
-
|
|
5099
|
-
|
|
5100
|
-
|
|
5101
|
-
|
|
5669
|
+
export type SymbolQuoteDto = {
|
|
5670
|
+
symbol?: string;
|
|
5671
|
+
name?: {
|
|
5672
|
+
[key: string]: unknown;
|
|
5673
|
+
} | null;
|
|
5674
|
+
exchange?: {
|
|
5675
|
+
[key: string]: unknown;
|
|
5676
|
+
} | null;
|
|
5102
5677
|
/**
|
|
5103
|
-
*
|
|
5678
|
+
* OpenBB asset_type
|
|
5104
5679
|
*/
|
|
5105
|
-
|
|
5680
|
+
assetType?: {
|
|
5681
|
+
[key: string]: unknown;
|
|
5682
|
+
} | null;
|
|
5106
5683
|
/**
|
|
5107
|
-
*
|
|
5684
|
+
* IGN asset class
|
|
5108
5685
|
*/
|
|
5109
|
-
|
|
5686
|
+
assetClass?: {
|
|
5687
|
+
[key: string]: unknown;
|
|
5688
|
+
} | null;
|
|
5110
5689
|
/**
|
|
5111
|
-
*
|
|
5690
|
+
* IGN asset sub-class
|
|
5112
5691
|
*/
|
|
5113
|
-
|
|
5114
|
-
|
|
5115
|
-
|
|
5116
|
-
export type CashFlowTrendSummaryDto = {
|
|
5692
|
+
assetSubClass?: {
|
|
5693
|
+
[key: string]: unknown;
|
|
5694
|
+
} | null;
|
|
5117
5695
|
/**
|
|
5118
|
-
*
|
|
5696
|
+
* Trading currency (extra_data or inferred from exchange)
|
|
5119
5697
|
*/
|
|
5120
|
-
|
|
5698
|
+
currency?: {
|
|
5699
|
+
[key: string]: unknown;
|
|
5700
|
+
} | null;
|
|
5121
5701
|
/**
|
|
5122
|
-
*
|
|
5702
|
+
* Latest price (Decimal string)
|
|
5123
5703
|
*/
|
|
5124
|
-
|
|
5704
|
+
price?: {
|
|
5705
|
+
[key: string]: unknown;
|
|
5706
|
+
} | null;
|
|
5125
5707
|
/**
|
|
5126
|
-
*
|
|
5708
|
+
* Date the price was observed (ISO yyyy-MM-dd)
|
|
5127
5709
|
*/
|
|
5128
|
-
|
|
5710
|
+
priceDate?: {
|
|
5711
|
+
[key: string]: unknown;
|
|
5712
|
+
} | null;
|
|
5129
5713
|
/**
|
|
5130
|
-
*
|
|
5714
|
+
* Change vs previous close, in percentage points (1.7 == 1.7%). openbb stores change_percent as a normalized decimal; this exposes percentage points for frontend convenience.
|
|
5131
5715
|
*/
|
|
5132
|
-
|
|
5133
|
-
|
|
5134
|
-
|
|
5135
|
-
export type CashFlowTrendsResponseDto = {
|
|
5716
|
+
changePercent?: {
|
|
5717
|
+
[key: string]: unknown;
|
|
5718
|
+
} | null;
|
|
5136
5719
|
/**
|
|
5137
|
-
*
|
|
5720
|
+
* Previous close (Decimal string)
|
|
5138
5721
|
*/
|
|
5139
|
-
|
|
5722
|
+
prevClose?: {
|
|
5723
|
+
[key: string]: unknown;
|
|
5724
|
+
} | null;
|
|
5140
5725
|
/**
|
|
5141
|
-
*
|
|
5726
|
+
* Day open (Decimal string)
|
|
5142
5727
|
*/
|
|
5143
|
-
|
|
5728
|
+
open?: {
|
|
5729
|
+
[key: string]: unknown;
|
|
5730
|
+
} | null;
|
|
5144
5731
|
/**
|
|
5145
|
-
*
|
|
5732
|
+
* Day high (Decimal string)
|
|
5146
5733
|
*/
|
|
5147
|
-
|
|
5734
|
+
high?: {
|
|
5735
|
+
[key: string]: unknown;
|
|
5736
|
+
} | null;
|
|
5148
5737
|
/**
|
|
5149
|
-
*
|
|
5738
|
+
* Day low (Decimal string)
|
|
5150
5739
|
*/
|
|
5151
|
-
|
|
5740
|
+
low?: {
|
|
5741
|
+
[key: string]: unknown;
|
|
5742
|
+
} | null;
|
|
5152
5743
|
/**
|
|
5153
|
-
*
|
|
5744
|
+
* Day volume (Decimal string)
|
|
5154
5745
|
*/
|
|
5155
|
-
|
|
5746
|
+
volume?: {
|
|
5747
|
+
[key: string]: unknown;
|
|
5748
|
+
} | null;
|
|
5156
5749
|
/**
|
|
5157
|
-
*
|
|
5750
|
+
* 52-week high (Decimal string)
|
|
5158
5751
|
*/
|
|
5159
|
-
|
|
5160
|
-
|
|
5161
|
-
|
|
5162
|
-
export type GenerateSnapshotBody = unknown;
|
|
5163
|
-
|
|
5164
|
-
export type GenerateSnapshotResponse = unknown;
|
|
5165
|
-
|
|
5166
|
-
export type BackfillSnapshotsBody = unknown;
|
|
5167
|
-
|
|
5168
|
-
export type BackfillSnapshotsResponse = unknown;
|
|
5169
|
-
|
|
5170
|
-
export type AnonymousLoginDto = {
|
|
5752
|
+
yearHigh?: {
|
|
5753
|
+
[key: string]: unknown;
|
|
5754
|
+
} | null;
|
|
5171
5755
|
/**
|
|
5172
|
-
*
|
|
5756
|
+
* 52-week low (Decimal string)
|
|
5173
5757
|
*/
|
|
5174
|
-
|
|
5758
|
+
yearLow?: {
|
|
5759
|
+
[key: string]: unknown;
|
|
5760
|
+
} | null;
|
|
5175
5761
|
};
|
|
5176
5762
|
|
|
5177
5763
|
export type AccountControllerCreateData = {
|
|
@@ -5202,7 +5788,7 @@ export type AccountControllerFindAllData = {
|
|
|
5202
5788
|
*/
|
|
5203
5789
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
5204
5790
|
/**
|
|
5205
|
-
* Search term for path
|
|
5791
|
+
* Search term for account path
|
|
5206
5792
|
*/
|
|
5207
5793
|
search?: string;
|
|
5208
5794
|
/**
|
|
@@ -5285,6 +5871,21 @@ export type AccountControllerReopenData = {
|
|
|
5285
5871
|
|
|
5286
5872
|
export type AccountControllerReopenResponse = AccountResponseDto;
|
|
5287
5873
|
|
|
5874
|
+
export type AccountControllerAddOpeningBalanceData = {
|
|
5875
|
+
/**
|
|
5876
|
+
* Account UUID
|
|
5877
|
+
*/
|
|
5878
|
+
id: string;
|
|
5879
|
+
/**
|
|
5880
|
+
* Region code for tenant context
|
|
5881
|
+
*/
|
|
5882
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
5883
|
+
requestBody: CreateOpeningBalanceDto;
|
|
5884
|
+
};
|
|
5885
|
+
|
|
5886
|
+
export type AccountControllerAddOpeningBalanceResponse =
|
|
5887
|
+
OpeningBalanceResultDto;
|
|
5888
|
+
|
|
5288
5889
|
export type AccountStandardsControllerGetTemplatesData = {
|
|
5289
5890
|
/**
|
|
5290
5891
|
* Region code (cn, us, de)
|
|
@@ -5473,7 +6074,7 @@ export type TransactionControllerDeleteResponse = void;
|
|
|
5473
6074
|
|
|
5474
6075
|
export type BalanceControllerGetBalanceData = {
|
|
5475
6076
|
/**
|
|
5476
|
-
* Account name (e.g., "Assets:
|
|
6077
|
+
* Account name (e.g., "Assets:Checking")
|
|
5477
6078
|
*/
|
|
5478
6079
|
account: string;
|
|
5479
6080
|
/**
|
|
@@ -5875,6 +6476,103 @@ export type CommodityControllerBulkCreateData = {
|
|
|
5875
6476
|
|
|
5876
6477
|
export type CommodityControllerBulkCreateResponse = Array<CommodityResponseDto>;
|
|
5877
6478
|
|
|
6479
|
+
export type PriceControllerCreateData = {
|
|
6480
|
+
/**
|
|
6481
|
+
* Region code for tenant context
|
|
6482
|
+
*/
|
|
6483
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6484
|
+
requestBody: CreateBeanPriceDto;
|
|
6485
|
+
};
|
|
6486
|
+
|
|
6487
|
+
export type PriceControllerCreateResponse = PriceResponseDto;
|
|
6488
|
+
|
|
6489
|
+
export type PriceControllerFindAllData = {
|
|
6490
|
+
/**
|
|
6491
|
+
* Filter by currency (e.g., BTC, AAPL, USD)
|
|
6492
|
+
*/
|
|
6493
|
+
currency?: string;
|
|
6494
|
+
/**
|
|
6495
|
+
* Filter prices from this date (ISO 8601 format)
|
|
6496
|
+
*/
|
|
6497
|
+
dateFrom?: string;
|
|
6498
|
+
/**
|
|
6499
|
+
* Filter prices to this date (ISO 8601 format)
|
|
6500
|
+
*/
|
|
6501
|
+
dateTo?: string;
|
|
6502
|
+
/**
|
|
6503
|
+
* Number of items per page (default: 20, max: 100)
|
|
6504
|
+
*/
|
|
6505
|
+
limit?: number;
|
|
6506
|
+
/**
|
|
6507
|
+
* Page number for pagination (default: 1)
|
|
6508
|
+
*/
|
|
6509
|
+
page?: number;
|
|
6510
|
+
/**
|
|
6511
|
+
* Filter by quote currency (pricing currency, e.g., USD, CNY)
|
|
6512
|
+
*/
|
|
6513
|
+
quoteCurrency?: string;
|
|
6514
|
+
/**
|
|
6515
|
+
* Region code for tenant context
|
|
6516
|
+
*/
|
|
6517
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6518
|
+
/**
|
|
6519
|
+
* Search term for currency or quoteCurrency (case-insensitive partial match)
|
|
6520
|
+
*/
|
|
6521
|
+
search?: string;
|
|
6522
|
+
};
|
|
6523
|
+
|
|
6524
|
+
export type PriceControllerFindAllResponse = PriceListResponseDto;
|
|
6525
|
+
|
|
6526
|
+
export type PriceControllerFindOneData = {
|
|
6527
|
+
/**
|
|
6528
|
+
* Price ID
|
|
6529
|
+
*/
|
|
6530
|
+
id: string;
|
|
6531
|
+
/**
|
|
6532
|
+
* Region code for tenant context
|
|
6533
|
+
*/
|
|
6534
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6535
|
+
};
|
|
6536
|
+
|
|
6537
|
+
export type PriceControllerFindOneResponse = PriceResponseDto;
|
|
6538
|
+
|
|
6539
|
+
export type PriceControllerUpdateData = {
|
|
6540
|
+
/**
|
|
6541
|
+
* Price ID
|
|
6542
|
+
*/
|
|
6543
|
+
id: string;
|
|
6544
|
+
/**
|
|
6545
|
+
* Region code for tenant context
|
|
6546
|
+
*/
|
|
6547
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6548
|
+
requestBody: UpdateBeanPriceDto;
|
|
6549
|
+
};
|
|
6550
|
+
|
|
6551
|
+
export type PriceControllerUpdateResponse = PriceResponseDto;
|
|
6552
|
+
|
|
6553
|
+
export type PriceControllerDeleteData = {
|
|
6554
|
+
/**
|
|
6555
|
+
* Price ID
|
|
6556
|
+
*/
|
|
6557
|
+
id: string;
|
|
6558
|
+
/**
|
|
6559
|
+
* Region code for tenant context
|
|
6560
|
+
*/
|
|
6561
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6562
|
+
};
|
|
6563
|
+
|
|
6564
|
+
export type PriceControllerDeleteResponse = void;
|
|
6565
|
+
|
|
6566
|
+
export type PriceControllerBulkCreateData = {
|
|
6567
|
+
/**
|
|
6568
|
+
* Region code for tenant context
|
|
6569
|
+
*/
|
|
6570
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6571
|
+
requestBody: Array<string>;
|
|
6572
|
+
};
|
|
6573
|
+
|
|
6574
|
+
export type PriceControllerBulkCreateResponse = Array<PriceResponseDto>;
|
|
6575
|
+
|
|
5878
6576
|
export type RecurringRuleControllerCreateData = {
|
|
5879
6577
|
/**
|
|
5880
6578
|
* Region code for tenant context
|
|
@@ -6016,97 +6714,245 @@ export type ExpectedTransactionControllerFindOneData = {
|
|
|
6016
6714
|
/**
|
|
6017
6715
|
* Expected transaction ID
|
|
6018
6716
|
*/
|
|
6019
|
-
id: string;
|
|
6717
|
+
id: string;
|
|
6718
|
+
/**
|
|
6719
|
+
* Region code for tenant context
|
|
6720
|
+
*/
|
|
6721
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6722
|
+
};
|
|
6723
|
+
|
|
6724
|
+
export type ExpectedTransactionControllerFindOneResponse =
|
|
6725
|
+
ExpectedTransactionResponseDto;
|
|
6726
|
+
|
|
6727
|
+
export type ExpectedTransactionControllerSkipData = {
|
|
6728
|
+
/**
|
|
6729
|
+
* Expected transaction ID
|
|
6730
|
+
*/
|
|
6731
|
+
id: string;
|
|
6732
|
+
/**
|
|
6733
|
+
* Region code for tenant context
|
|
6734
|
+
*/
|
|
6735
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6736
|
+
};
|
|
6737
|
+
|
|
6738
|
+
export type ExpectedTransactionControllerSkipResponse =
|
|
6739
|
+
ExpectedTransactionResponseDto;
|
|
6740
|
+
|
|
6741
|
+
export type ExpectedTransactionControllerUndoSkipData = {
|
|
6742
|
+
/**
|
|
6743
|
+
* Expected transaction ID
|
|
6744
|
+
*/
|
|
6745
|
+
id: string;
|
|
6746
|
+
/**
|
|
6747
|
+
* Region code for tenant context
|
|
6748
|
+
*/
|
|
6749
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6750
|
+
};
|
|
6751
|
+
|
|
6752
|
+
export type ExpectedTransactionControllerUndoSkipResponse =
|
|
6753
|
+
ExpectedTransactionResponseDto;
|
|
6754
|
+
|
|
6755
|
+
export type ExpectedTransactionControllerConfirmMatchData = {
|
|
6756
|
+
/**
|
|
6757
|
+
* Expected transaction ID
|
|
6758
|
+
*/
|
|
6759
|
+
id: string;
|
|
6760
|
+
/**
|
|
6761
|
+
* Region code for tenant context
|
|
6762
|
+
*/
|
|
6763
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6764
|
+
requestBody: ConfirmMatchDto;
|
|
6765
|
+
};
|
|
6766
|
+
|
|
6767
|
+
export type ExpectedTransactionControllerConfirmMatchResponse = unknown;
|
|
6768
|
+
|
|
6769
|
+
export type ExpectedTransactionControllerUnmatchData = {
|
|
6770
|
+
/**
|
|
6771
|
+
* Expected transaction ID
|
|
6772
|
+
*/
|
|
6773
|
+
id: string;
|
|
6774
|
+
/**
|
|
6775
|
+
* Region code for tenant context
|
|
6776
|
+
*/
|
|
6777
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6778
|
+
};
|
|
6779
|
+
|
|
6780
|
+
export type ExpectedTransactionControllerUnmatchResponse = unknown;
|
|
6781
|
+
|
|
6782
|
+
export type ExpectedTransactionControllerEnterNowData = {
|
|
6783
|
+
/**
|
|
6784
|
+
* Expected transaction ID
|
|
6785
|
+
*/
|
|
6786
|
+
id: string;
|
|
6787
|
+
/**
|
|
6788
|
+
* Region code for tenant context
|
|
6789
|
+
*/
|
|
6790
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6791
|
+
requestBody: EnterNowDto;
|
|
6792
|
+
};
|
|
6793
|
+
|
|
6794
|
+
export type ExpectedTransactionControllerEnterNowResponse = unknown;
|
|
6795
|
+
|
|
6796
|
+
export type ForecastControllerGetForecastData = {
|
|
6797
|
+
/**
|
|
6798
|
+
* Number of months to forecast (1-12, default 3)
|
|
6799
|
+
*/
|
|
6800
|
+
months?: number;
|
|
6801
|
+
/**
|
|
6802
|
+
* Region code for tenant context
|
|
6803
|
+
*/
|
|
6804
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6805
|
+
};
|
|
6806
|
+
|
|
6807
|
+
export type ForecastControllerGetForecastResponse = ForecastResponseDto;
|
|
6808
|
+
|
|
6809
|
+
export type ReportingControllerGetPortfolioTrendsData = {
|
|
6810
|
+
/**
|
|
6811
|
+
* Data granularity
|
|
6812
|
+
*/
|
|
6813
|
+
granularity?: 'day' | 'week' | 'month';
|
|
6814
|
+
/**
|
|
6815
|
+
* Time period
|
|
6816
|
+
*/
|
|
6817
|
+
period?: '1m' | '3m' | '6m' | '1y';
|
|
6020
6818
|
/**
|
|
6021
6819
|
* Region code for tenant context
|
|
6022
6820
|
*/
|
|
6023
6821
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6024
6822
|
};
|
|
6025
6823
|
|
|
6026
|
-
export type
|
|
6027
|
-
|
|
6824
|
+
export type ReportingControllerGetPortfolioTrendsResponse =
|
|
6825
|
+
PortfolioTrendsResponseDto;
|
|
6028
6826
|
|
|
6029
|
-
export type
|
|
6827
|
+
export type ReportingControllerGetCashFlowTrendsData = {
|
|
6030
6828
|
/**
|
|
6031
|
-
*
|
|
6829
|
+
* Data granularity (accepted for API symmetry; v1 returns month buckets)
|
|
6032
6830
|
*/
|
|
6033
|
-
|
|
6831
|
+
granularity?: 'day' | 'week' | 'month';
|
|
6832
|
+
/**
|
|
6833
|
+
* Time period
|
|
6834
|
+
*/
|
|
6835
|
+
period?: '1m' | '3m' | '6m' | '1y';
|
|
6034
6836
|
/**
|
|
6035
6837
|
* Region code for tenant context
|
|
6036
6838
|
*/
|
|
6037
6839
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6038
6840
|
};
|
|
6039
6841
|
|
|
6040
|
-
export type
|
|
6041
|
-
|
|
6842
|
+
export type ReportingControllerGetCashFlowTrendsResponse =
|
|
6843
|
+
CashFlowTrendsResponseDto;
|
|
6042
6844
|
|
|
6043
|
-
export type
|
|
6044
|
-
/**
|
|
6045
|
-
* Expected transaction ID
|
|
6046
|
-
*/
|
|
6047
|
-
id: string;
|
|
6845
|
+
export type ReportingControllerGenerateSnapshotData = {
|
|
6048
6846
|
/**
|
|
6049
6847
|
* Region code for tenant context
|
|
6050
6848
|
*/
|
|
6051
6849
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6850
|
+
/**
|
|
6851
|
+
* Optional date (defaults to today)
|
|
6852
|
+
*/
|
|
6853
|
+
requestBody: GenerateSnapshotBody;
|
|
6052
6854
|
};
|
|
6053
6855
|
|
|
6054
|
-
export type
|
|
6055
|
-
|
|
6856
|
+
export type ReportingControllerGenerateSnapshotResponse =
|
|
6857
|
+
GenerateSnapshotResponse;
|
|
6056
6858
|
|
|
6057
|
-
export type
|
|
6058
|
-
/**
|
|
6059
|
-
* Expected transaction ID
|
|
6060
|
-
*/
|
|
6061
|
-
id: string;
|
|
6859
|
+
export type ReportingControllerBackfillSnapshotsData = {
|
|
6062
6860
|
/**
|
|
6063
6861
|
* Region code for tenant context
|
|
6064
6862
|
*/
|
|
6065
6863
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6066
|
-
requestBody:
|
|
6864
|
+
requestBody: BackfillSnapshotsBody;
|
|
6067
6865
|
};
|
|
6068
6866
|
|
|
6069
|
-
export type
|
|
6867
|
+
export type ReportingControllerBackfillSnapshotsResponse =
|
|
6868
|
+
BackfillSnapshotsResponse;
|
|
6070
6869
|
|
|
6071
|
-
export type
|
|
6870
|
+
export type UserControllerDeleteOwnUserData = {
|
|
6871
|
+
requestBody: DeleteOwnUserDto;
|
|
6872
|
+
};
|
|
6873
|
+
|
|
6874
|
+
export type UserControllerDeleteOwnUserResponse = void;
|
|
6875
|
+
|
|
6876
|
+
export type UserControllerGetUserData = {
|
|
6877
|
+
acceptLanguage: string;
|
|
6878
|
+
};
|
|
6879
|
+
|
|
6880
|
+
export type UserControllerGetUserResponse = unknown;
|
|
6881
|
+
|
|
6882
|
+
export type UserControllerSignupUserData = {
|
|
6883
|
+
requestBody: SignupDto;
|
|
6884
|
+
};
|
|
6885
|
+
|
|
6886
|
+
export type UserControllerSignupUserResponse = SignupResponseDto;
|
|
6887
|
+
|
|
6888
|
+
export type UserControllerDeleteUserData = {
|
|
6072
6889
|
/**
|
|
6073
|
-
*
|
|
6890
|
+
* User ID to delete
|
|
6074
6891
|
*/
|
|
6075
6892
|
id: string;
|
|
6893
|
+
};
|
|
6894
|
+
|
|
6895
|
+
export type UserControllerDeleteUserResponse = void;
|
|
6896
|
+
|
|
6897
|
+
export type UserControllerGetUserInfoData = {
|
|
6076
6898
|
/**
|
|
6077
|
-
*
|
|
6899
|
+
* User ID
|
|
6078
6900
|
*/
|
|
6079
|
-
|
|
6901
|
+
id: string;
|
|
6080
6902
|
};
|
|
6081
6903
|
|
|
6082
|
-
export type
|
|
6904
|
+
export type UserControllerGetUserInfoResponse = unknown;
|
|
6083
6905
|
|
|
6084
|
-
export type
|
|
6906
|
+
export type UserControllerUpdateUserSettingData = {
|
|
6907
|
+
requestBody: UpdateUserSettingDto;
|
|
6908
|
+
};
|
|
6909
|
+
|
|
6910
|
+
export type UserControllerUpdateUserSettingResponse = unknown;
|
|
6911
|
+
|
|
6912
|
+
export type UserControllerGetAllUserSettingsByPageData = {
|
|
6085
6913
|
/**
|
|
6086
|
-
*
|
|
6914
|
+
* Page number
|
|
6087
6915
|
*/
|
|
6088
|
-
|
|
6916
|
+
pageNo: number;
|
|
6089
6917
|
/**
|
|
6090
|
-
*
|
|
6918
|
+
* Page size
|
|
6091
6919
|
*/
|
|
6092
|
-
|
|
6093
|
-
requestBody: EnterNowDto;
|
|
6920
|
+
pageSize: number;
|
|
6094
6921
|
};
|
|
6095
6922
|
|
|
6096
|
-
export type
|
|
6923
|
+
export type UserControllerGetAllUserSettingsByPageResponse = unknown;
|
|
6097
6924
|
|
|
6098
|
-
export type
|
|
6925
|
+
export type UserControllerGetAssetLiabilitySummaryResponse = unknown;
|
|
6926
|
+
|
|
6927
|
+
export type PropertyControllerGetAllResponse = unknown;
|
|
6928
|
+
|
|
6929
|
+
export type PropertyControllerGetByKeyData = {
|
|
6099
6930
|
/**
|
|
6100
|
-
*
|
|
6931
|
+
* Property key
|
|
6101
6932
|
*/
|
|
6102
|
-
|
|
6933
|
+
key: string;
|
|
6934
|
+
};
|
|
6935
|
+
|
|
6936
|
+
export type PropertyControllerGetByKeyResponse = unknown;
|
|
6937
|
+
|
|
6938
|
+
export type PropertyControllerUpdateData = {
|
|
6103
6939
|
/**
|
|
6104
|
-
*
|
|
6940
|
+
* Property key
|
|
6105
6941
|
*/
|
|
6106
|
-
|
|
6942
|
+
key: string;
|
|
6943
|
+
requestBody: UpdatePropertyDto;
|
|
6107
6944
|
};
|
|
6108
6945
|
|
|
6109
|
-
export type
|
|
6946
|
+
export type PropertyControllerUpdateResponse = unknown;
|
|
6947
|
+
|
|
6948
|
+
export type PropertyControllerDeleteData = {
|
|
6949
|
+
/**
|
|
6950
|
+
* Property key
|
|
6951
|
+
*/
|
|
6952
|
+
key: string;
|
|
6953
|
+
};
|
|
6954
|
+
|
|
6955
|
+
export type PropertyControllerDeleteResponse = void;
|
|
6110
6956
|
|
|
6111
6957
|
export type TransactionRuleControllerCreateData = {
|
|
6112
6958
|
/**
|
|
@@ -6253,93 +7099,6 @@ export type TransactionRuleControllerTestData = {
|
|
|
6253
7099
|
|
|
6254
7100
|
export type TransactionRuleControllerTestResponse = TestRuleResponseDto;
|
|
6255
7101
|
|
|
6256
|
-
export type UserControllerDeleteOwnUserData = {
|
|
6257
|
-
requestBody: DeleteOwnUserDto;
|
|
6258
|
-
};
|
|
6259
|
-
|
|
6260
|
-
export type UserControllerDeleteOwnUserResponse = void;
|
|
6261
|
-
|
|
6262
|
-
export type UserControllerGetUserData = {
|
|
6263
|
-
acceptLanguage: string;
|
|
6264
|
-
};
|
|
6265
|
-
|
|
6266
|
-
export type UserControllerGetUserResponse = unknown;
|
|
6267
|
-
|
|
6268
|
-
export type UserControllerSignupUserData = {
|
|
6269
|
-
requestBody: SignupDto;
|
|
6270
|
-
};
|
|
6271
|
-
|
|
6272
|
-
export type UserControllerSignupUserResponse = unknown;
|
|
6273
|
-
|
|
6274
|
-
export type UserControllerDeleteUserData = {
|
|
6275
|
-
/**
|
|
6276
|
-
* User ID to delete
|
|
6277
|
-
*/
|
|
6278
|
-
id: string;
|
|
6279
|
-
};
|
|
6280
|
-
|
|
6281
|
-
export type UserControllerDeleteUserResponse = void;
|
|
6282
|
-
|
|
6283
|
-
export type UserControllerGetUserInfoData = {
|
|
6284
|
-
/**
|
|
6285
|
-
* User ID
|
|
6286
|
-
*/
|
|
6287
|
-
id: string;
|
|
6288
|
-
};
|
|
6289
|
-
|
|
6290
|
-
export type UserControllerGetUserInfoResponse = unknown;
|
|
6291
|
-
|
|
6292
|
-
export type UserControllerUpdateUserSettingData = {
|
|
6293
|
-
requestBody: UpdateUserSettingDto;
|
|
6294
|
-
};
|
|
6295
|
-
|
|
6296
|
-
export type UserControllerUpdateUserSettingResponse = unknown;
|
|
6297
|
-
|
|
6298
|
-
export type UserControllerGetAllUserSettingsByPageData = {
|
|
6299
|
-
/**
|
|
6300
|
-
* Page number
|
|
6301
|
-
*/
|
|
6302
|
-
pageNo: number;
|
|
6303
|
-
/**
|
|
6304
|
-
* Page size
|
|
6305
|
-
*/
|
|
6306
|
-
pageSize: number;
|
|
6307
|
-
};
|
|
6308
|
-
|
|
6309
|
-
export type UserControllerGetAllUserSettingsByPageResponse = unknown;
|
|
6310
|
-
|
|
6311
|
-
export type UserControllerGetAssetLiabilitySummaryResponse = unknown;
|
|
6312
|
-
|
|
6313
|
-
export type PropertyControllerGetAllResponse = unknown;
|
|
6314
|
-
|
|
6315
|
-
export type PropertyControllerGetByKeyData = {
|
|
6316
|
-
/**
|
|
6317
|
-
* Property key
|
|
6318
|
-
*/
|
|
6319
|
-
key: string;
|
|
6320
|
-
};
|
|
6321
|
-
|
|
6322
|
-
export type PropertyControllerGetByKeyResponse = unknown;
|
|
6323
|
-
|
|
6324
|
-
export type PropertyControllerUpdateData = {
|
|
6325
|
-
/**
|
|
6326
|
-
* Property key
|
|
6327
|
-
*/
|
|
6328
|
-
key: string;
|
|
6329
|
-
requestBody: UpdatePropertyDto;
|
|
6330
|
-
};
|
|
6331
|
-
|
|
6332
|
-
export type PropertyControllerUpdateResponse = unknown;
|
|
6333
|
-
|
|
6334
|
-
export type PropertyControllerDeleteData = {
|
|
6335
|
-
/**
|
|
6336
|
-
* Property key
|
|
6337
|
-
*/
|
|
6338
|
-
key: string;
|
|
6339
|
-
};
|
|
6340
|
-
|
|
6341
|
-
export type PropertyControllerDeleteResponse = void;
|
|
6342
|
-
|
|
6343
7102
|
export type EventControllerCreateData = {
|
|
6344
7103
|
/**
|
|
6345
7104
|
* Region code for tenant context (decorative for life events)
|
|
@@ -6416,27 +7175,82 @@ export type EventControllerDeleteData = {
|
|
|
6416
7175
|
*/
|
|
6417
7176
|
id: string;
|
|
6418
7177
|
/**
|
|
6419
|
-
* Region code for tenant context (decorative for life events)
|
|
7178
|
+
* Region code for tenant context (decorative for life events)
|
|
7179
|
+
*/
|
|
7180
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7181
|
+
};
|
|
7182
|
+
|
|
7183
|
+
export type EventControllerDeleteResponse = void;
|
|
7184
|
+
|
|
7185
|
+
export type EventControllerGetSliceData = {
|
|
7186
|
+
accountPattern: string;
|
|
7187
|
+
granularity: string;
|
|
7188
|
+
/**
|
|
7189
|
+
* Life event ID
|
|
7190
|
+
*/
|
|
7191
|
+
id: string;
|
|
7192
|
+
/**
|
|
7193
|
+
* Region code for tenant context (decorative for life events)
|
|
7194
|
+
*/
|
|
7195
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7196
|
+
};
|
|
7197
|
+
|
|
7198
|
+
export type EventControllerGetSliceResponse = unknown;
|
|
7199
|
+
|
|
7200
|
+
export type OnboardingControllerBootstrapData = {
|
|
7201
|
+
/**
|
|
7202
|
+
* Region code for tenant context
|
|
7203
|
+
*/
|
|
7204
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7205
|
+
requestBody: OnboardingDto;
|
|
7206
|
+
};
|
|
7207
|
+
|
|
7208
|
+
export type OnboardingControllerBootstrapResponse = unknown;
|
|
7209
|
+
|
|
7210
|
+
export type ReconciliationControllerComputeData = {
|
|
7211
|
+
/**
|
|
7212
|
+
* Region code for tenant context (decorative for reconciliation)
|
|
7213
|
+
*/
|
|
7214
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7215
|
+
requestBody: ComputeReconciliationDto;
|
|
7216
|
+
};
|
|
7217
|
+
|
|
7218
|
+
export type ReconciliationControllerComputeResponse =
|
|
7219
|
+
ReconciliationComputeResultDto;
|
|
7220
|
+
|
|
7221
|
+
export type ReconciliationControllerAssertData = {
|
|
7222
|
+
/**
|
|
7223
|
+
* Region code for tenant context (decorative for reconciliation)
|
|
7224
|
+
*/
|
|
7225
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7226
|
+
requestBody: AssertReconciliationDto;
|
|
7227
|
+
};
|
|
7228
|
+
|
|
7229
|
+
export type ReconciliationControllerAssertResponse = ReconciliationRecordDto;
|
|
7230
|
+
|
|
7231
|
+
export type ReconciliationControllerPadData = {
|
|
7232
|
+
/**
|
|
7233
|
+
* Region code for tenant context (decorative for reconciliation)
|
|
6420
7234
|
*/
|
|
6421
7235
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7236
|
+
requestBody: PadReconciliationDto;
|
|
6422
7237
|
};
|
|
6423
7238
|
|
|
6424
|
-
export type
|
|
7239
|
+
export type ReconciliationControllerPadResponse = PadResultDto;
|
|
6425
7240
|
|
|
6426
|
-
export type
|
|
6427
|
-
accountPattern: string;
|
|
6428
|
-
granularity: string;
|
|
7241
|
+
export type ReconciliationControllerHistoryData = {
|
|
6429
7242
|
/**
|
|
6430
|
-
*
|
|
7243
|
+
* BeanAccount id
|
|
6431
7244
|
*/
|
|
6432
|
-
|
|
7245
|
+
accountId: string;
|
|
6433
7246
|
/**
|
|
6434
|
-
* Region code for tenant context (decorative for
|
|
7247
|
+
* Region code for tenant context (decorative for reconciliation)
|
|
6435
7248
|
*/
|
|
6436
7249
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6437
7250
|
};
|
|
6438
7251
|
|
|
6439
|
-
export type
|
|
7252
|
+
export type ReconciliationControllerHistoryResponse =
|
|
7253
|
+
Array<ReconciliationRecordDto>;
|
|
6440
7254
|
|
|
6441
7255
|
export type ExportControllerExportBeancountResponse = unknown;
|
|
6442
7256
|
|
|
@@ -6530,48 +7344,6 @@ export type ImporterConfigControllerResetConfigData = {
|
|
|
6530
7344
|
|
|
6531
7345
|
export type ImporterConfigControllerResetConfigResponse = ImporterConfigDto;
|
|
6532
7346
|
|
|
6533
|
-
export type PlatformControllerFindAllResponse = unknown;
|
|
6534
|
-
|
|
6535
|
-
export type PlatformControllerCreateData = {
|
|
6536
|
-
requestBody: CreatePlatformDto;
|
|
6537
|
-
};
|
|
6538
|
-
|
|
6539
|
-
export type PlatformControllerCreateResponse = unknown;
|
|
6540
|
-
|
|
6541
|
-
export type PlatformControllerGetPlatformListResponse = unknown;
|
|
6542
|
-
|
|
6543
|
-
export type PlatformControllerMatchPlatformsData = {
|
|
6544
|
-
/**
|
|
6545
|
-
* Search query — Chinese name, English name, or abbreviation
|
|
6546
|
-
*/
|
|
6547
|
-
q: string;
|
|
6548
|
-
/**
|
|
6549
|
-
* Region code for category override lookup
|
|
6550
|
-
*/
|
|
6551
|
-
region?: string;
|
|
6552
|
-
};
|
|
6553
|
-
|
|
6554
|
-
export type PlatformControllerMatchPlatformsResponse = unknown;
|
|
6555
|
-
|
|
6556
|
-
export type PlatformControllerUpdateData = {
|
|
6557
|
-
/**
|
|
6558
|
-
* Platform ID
|
|
6559
|
-
*/
|
|
6560
|
-
id: string;
|
|
6561
|
-
requestBody: UpdatePlatformDto;
|
|
6562
|
-
};
|
|
6563
|
-
|
|
6564
|
-
export type PlatformControllerUpdateResponse = unknown;
|
|
6565
|
-
|
|
6566
|
-
export type PlatformControllerDeleteData = {
|
|
6567
|
-
/**
|
|
6568
|
-
* Platform ID
|
|
6569
|
-
*/
|
|
6570
|
-
id: string;
|
|
6571
|
-
};
|
|
6572
|
-
|
|
6573
|
-
export type PlatformControllerDeleteResponse = void;
|
|
6574
|
-
|
|
6575
7347
|
export type ProviderSyncControllerSyncData = {
|
|
6576
7348
|
/**
|
|
6577
7349
|
* Provider name
|
|
@@ -6617,6 +7389,49 @@ export type ProviderSyncControllerIsProviderSupportedData = {
|
|
|
6617
7389
|
|
|
6618
7390
|
export type ProviderSyncControllerIsProviderSupportedResponse = unknown;
|
|
6619
7391
|
|
|
7392
|
+
export type ExternalAccountLinkControllerCreateData = {
|
|
7393
|
+
/**
|
|
7394
|
+
* Region code for tenant context
|
|
7395
|
+
*/
|
|
7396
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7397
|
+
requestBody: CreateExternalAccountLinkDto;
|
|
7398
|
+
};
|
|
7399
|
+
|
|
7400
|
+
export type ExternalAccountLinkControllerCreateResponse =
|
|
7401
|
+
ExternalAccountLinkResponseDto;
|
|
7402
|
+
|
|
7403
|
+
export type ExternalAccountLinkControllerFindAllData = {
|
|
7404
|
+
provider: string;
|
|
7405
|
+
/**
|
|
7406
|
+
* Region code for tenant context
|
|
7407
|
+
*/
|
|
7408
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7409
|
+
};
|
|
7410
|
+
|
|
7411
|
+
export type ExternalAccountLinkControllerFindAllResponse =
|
|
7412
|
+
ExternalAccountLinkListResponseDto;
|
|
7413
|
+
|
|
7414
|
+
export type ExternalAccountLinkControllerFindOneData = {
|
|
7415
|
+
id: string;
|
|
7416
|
+
/**
|
|
7417
|
+
* Region code for tenant context
|
|
7418
|
+
*/
|
|
7419
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7420
|
+
};
|
|
7421
|
+
|
|
7422
|
+
export type ExternalAccountLinkControllerFindOneResponse =
|
|
7423
|
+
ExternalAccountLinkResponseDto;
|
|
7424
|
+
|
|
7425
|
+
export type ExternalAccountLinkControllerRemoveData = {
|
|
7426
|
+
id: string;
|
|
7427
|
+
/**
|
|
7428
|
+
* Region code for tenant context
|
|
7429
|
+
*/
|
|
7430
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7431
|
+
};
|
|
7432
|
+
|
|
7433
|
+
export type ExternalAccountLinkControllerRemoveResponse = void;
|
|
7434
|
+
|
|
6620
7435
|
export type TelemetryControllerReportTelemetryData = {
|
|
6621
7436
|
/**
|
|
6622
7437
|
* Region code for tenant context
|
|
@@ -6689,225 +7504,114 @@ export type NlpControllerGetSessionData = {
|
|
|
6689
7504
|
|
|
6690
7505
|
export type NlpControllerGetSessionResponse = unknown;
|
|
6691
7506
|
|
|
6692
|
-
export type
|
|
6693
|
-
/**
|
|
6694
|
-
* Date for balance calculation (ISO 8601 format)
|
|
6695
|
-
*/
|
|
6696
|
-
date?: string;
|
|
6697
|
-
/**
|
|
6698
|
-
* Region code for tenant context
|
|
6699
|
-
*/
|
|
6700
|
-
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6701
|
-
};
|
|
6702
|
-
|
|
6703
|
-
export type DashboardControllerGetNetWorthResponse = NetWorthResponseDto;
|
|
6704
|
-
|
|
6705
|
-
export type DashboardControllerGetAccountsData = {
|
|
6706
|
-
/**
|
|
6707
|
-
* Scope to a single account (only valid with groupBy=holdingAssetClass, ADR-0105 §6)
|
|
6708
|
-
*/
|
|
6709
|
-
accountId?: string;
|
|
6710
|
-
/**
|
|
6711
|
-
* Date for balance calculation (ISO 8601 format)
|
|
6712
|
-
*/
|
|
6713
|
-
date?: string;
|
|
6714
|
-
/**
|
|
6715
|
-
* Grouping strategy
|
|
6716
|
-
*/
|
|
6717
|
-
groupBy?:
|
|
6718
|
-
| 'platform'
|
|
6719
|
-
| 'assetClass'
|
|
6720
|
-
| 'holdingAssetClass'
|
|
6721
|
-
| 'holdingAssetClassByAccount';
|
|
6722
|
-
/**
|
|
6723
|
-
* Region code for tenant context
|
|
6724
|
-
*/
|
|
6725
|
-
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6726
|
-
};
|
|
6727
|
-
|
|
6728
|
-
export type DashboardControllerGetAccountsResponse =
|
|
6729
|
-
| AccountsResponseDto
|
|
6730
|
-
| AssetClassAccountsResponseDto
|
|
6731
|
-
| HoldingAssetClassCrossAccountResponseDto;
|
|
7507
|
+
export type PlatformControllerFindAllResponse = unknown;
|
|
6732
7508
|
|
|
6733
|
-
export type
|
|
6734
|
-
|
|
6735
|
-
* Period in YYYY-MM format
|
|
6736
|
-
*/
|
|
6737
|
-
period: string;
|
|
6738
|
-
/**
|
|
6739
|
-
* Region code for tenant context
|
|
6740
|
-
*/
|
|
6741
|
-
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7509
|
+
export type PlatformControllerCreateData = {
|
|
7510
|
+
requestBody: CreatePlatformDto;
|
|
6742
7511
|
};
|
|
6743
7512
|
|
|
6744
|
-
export type
|
|
6745
|
-
|
|
6746
|
-
export type DashboardControllerGetExpensesData = {
|
|
6747
|
-
/**
|
|
6748
|
-
* Account root to aggregate (expense → ^Expenses:, income → ^Income:)
|
|
6749
|
-
*/
|
|
6750
|
-
flow?: 'expense' | 'income';
|
|
6751
|
-
/**
|
|
6752
|
-
* Grouping strategy
|
|
6753
|
-
*/
|
|
6754
|
-
groupBy?: 'category';
|
|
6755
|
-
/**
|
|
6756
|
-
* Time window (1m = current calendar month)
|
|
6757
|
-
*/
|
|
6758
|
-
period?: '1m' | '3m' | '6m' | '1y';
|
|
6759
|
-
/**
|
|
6760
|
-
* Region code for tenant context
|
|
6761
|
-
*/
|
|
6762
|
-
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6763
|
-
};
|
|
7513
|
+
export type PlatformControllerCreateResponse = unknown;
|
|
6764
7514
|
|
|
6765
|
-
export type
|
|
6766
|
-
|
|
7515
|
+
export type PlatformControllerGetPlatformListResponse =
|
|
7516
|
+
Array<PlatformListItemDto>;
|
|
6767
7517
|
|
|
6768
|
-
export type
|
|
6769
|
-
/**
|
|
6770
|
-
* Scope to a single account
|
|
6771
|
-
*/
|
|
6772
|
-
accountId?: string;
|
|
6773
|
-
/**
|
|
6774
|
-
* As-of date (ISO 8601), defaults to today
|
|
6775
|
-
*/
|
|
6776
|
-
asOf?: string;
|
|
6777
|
-
/**
|
|
6778
|
-
* Realized-P&L lot-matching method (default average). Does not affect the average-cost unrealized basis.
|
|
6779
|
-
*/
|
|
6780
|
-
method?: 'FIFO' | 'average';
|
|
7518
|
+
export type PlatformControllerMatchPlatformsData = {
|
|
6781
7519
|
/**
|
|
6782
|
-
*
|
|
7520
|
+
* Search query — Chinese name, English name, or abbreviation
|
|
6783
7521
|
*/
|
|
6784
|
-
|
|
6785
|
-
};
|
|
6786
|
-
|
|
6787
|
-
export type HoldingPnlControllerGetHoldingPnlResponse = HoldingPnlResponseDto;
|
|
6788
|
-
|
|
6789
|
-
export type PriceControllerCreateData = {
|
|
7522
|
+
q: string;
|
|
6790
7523
|
/**
|
|
6791
|
-
* Region code for
|
|
7524
|
+
* Region code for category override lookup
|
|
6792
7525
|
*/
|
|
6793
|
-
region
|
|
6794
|
-
requestBody: CreateBeanPriceDto;
|
|
7526
|
+
region?: string;
|
|
6795
7527
|
};
|
|
6796
7528
|
|
|
6797
|
-
export type
|
|
7529
|
+
export type PlatformControllerMatchPlatformsResponse = PlatformMatchResponseDto;
|
|
6798
7530
|
|
|
6799
|
-
export type
|
|
6800
|
-
/**
|
|
6801
|
-
* Filter by currency (e.g., BTC, AAPL, USD)
|
|
6802
|
-
*/
|
|
6803
|
-
currency?: string;
|
|
6804
|
-
/**
|
|
6805
|
-
* Filter prices from this date (ISO 8601 format)
|
|
6806
|
-
*/
|
|
6807
|
-
dateFrom?: string;
|
|
6808
|
-
/**
|
|
6809
|
-
* Filter prices to this date (ISO 8601 format)
|
|
6810
|
-
*/
|
|
6811
|
-
dateTo?: string;
|
|
6812
|
-
/**
|
|
6813
|
-
* Number of items per page (default: 20, max: 100)
|
|
6814
|
-
*/
|
|
6815
|
-
limit?: number;
|
|
6816
|
-
/**
|
|
6817
|
-
* Page number for pagination (default: 1)
|
|
6818
|
-
*/
|
|
6819
|
-
page?: number;
|
|
6820
|
-
/**
|
|
6821
|
-
* Filter by quote currency (pricing currency, e.g., USD, CNY)
|
|
6822
|
-
*/
|
|
6823
|
-
quoteCurrency?: string;
|
|
6824
|
-
/**
|
|
6825
|
-
* Region code for tenant context
|
|
6826
|
-
*/
|
|
6827
|
-
region: 'cn' | 'us' | 'de' | 'gb';
|
|
7531
|
+
export type PlatformControllerUpdateData = {
|
|
6828
7532
|
/**
|
|
6829
|
-
*
|
|
7533
|
+
* Platform ID
|
|
6830
7534
|
*/
|
|
6831
|
-
|
|
7535
|
+
id: string;
|
|
7536
|
+
requestBody: UpdatePlatformDto;
|
|
6832
7537
|
};
|
|
6833
7538
|
|
|
6834
|
-
export type
|
|
7539
|
+
export type PlatformControllerUpdateResponse = unknown;
|
|
6835
7540
|
|
|
6836
|
-
export type
|
|
7541
|
+
export type PlatformControllerDeleteData = {
|
|
6837
7542
|
/**
|
|
6838
|
-
*
|
|
7543
|
+
* Platform ID
|
|
6839
7544
|
*/
|
|
6840
7545
|
id: string;
|
|
6841
|
-
/**
|
|
6842
|
-
* Region code for tenant context
|
|
6843
|
-
*/
|
|
6844
|
-
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6845
7546
|
};
|
|
6846
7547
|
|
|
6847
|
-
export type
|
|
7548
|
+
export type PlatformControllerDeleteResponse = void;
|
|
6848
7549
|
|
|
6849
|
-
export type
|
|
7550
|
+
export type DashboardControllerGetNetWorthData = {
|
|
6850
7551
|
/**
|
|
6851
|
-
*
|
|
7552
|
+
* Date for balance calculation (ISO 8601 format)
|
|
6852
7553
|
*/
|
|
6853
|
-
|
|
7554
|
+
date?: string;
|
|
6854
7555
|
/**
|
|
6855
7556
|
* Region code for tenant context
|
|
6856
7557
|
*/
|
|
6857
7558
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6858
|
-
requestBody: UpdateBeanPriceDto;
|
|
6859
7559
|
};
|
|
6860
7560
|
|
|
6861
|
-
export type
|
|
7561
|
+
export type DashboardControllerGetNetWorthResponse = NetWorthResponseDto;
|
|
6862
7562
|
|
|
6863
|
-
export type
|
|
7563
|
+
export type DashboardControllerGetAccountsData = {
|
|
6864
7564
|
/**
|
|
6865
|
-
*
|
|
7565
|
+
* Scope to a single account (only valid with groupBy=holdingAssetClass, ADR-0105 §6)
|
|
6866
7566
|
*/
|
|
6867
|
-
|
|
7567
|
+
accountId?: string;
|
|
6868
7568
|
/**
|
|
6869
|
-
*
|
|
7569
|
+
* Date for balance calculation (ISO 8601 format)
|
|
6870
7570
|
*/
|
|
6871
|
-
|
|
6872
|
-
|
|
6873
|
-
|
|
6874
|
-
|
|
6875
|
-
|
|
6876
|
-
|
|
7571
|
+
date?: string;
|
|
7572
|
+
/**
|
|
7573
|
+
* Grouping strategy
|
|
7574
|
+
*/
|
|
7575
|
+
groupBy?:
|
|
7576
|
+
| 'platform'
|
|
7577
|
+
| 'assetClass'
|
|
7578
|
+
| 'holdingAssetClass'
|
|
7579
|
+
| 'holdingAssetClassByAccount';
|
|
6877
7580
|
/**
|
|
6878
7581
|
* Region code for tenant context
|
|
6879
7582
|
*/
|
|
6880
7583
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6881
|
-
requestBody: Array<string>;
|
|
6882
7584
|
};
|
|
6883
7585
|
|
|
6884
|
-
export type
|
|
7586
|
+
export type DashboardControllerGetAccountsResponse =
|
|
7587
|
+
| AccountsResponseDto
|
|
7588
|
+
| AssetClassAccountsResponseDto
|
|
7589
|
+
| HoldingAssetClassCrossAccountResponseDto;
|
|
6885
7590
|
|
|
6886
|
-
export type
|
|
6887
|
-
/**
|
|
6888
|
-
* Data granularity
|
|
6889
|
-
*/
|
|
6890
|
-
granularity?: 'day' | 'week' | 'month';
|
|
7591
|
+
export type DashboardControllerGetCashFlowData = {
|
|
6891
7592
|
/**
|
|
6892
|
-
*
|
|
7593
|
+
* Period in YYYY-MM format
|
|
6893
7594
|
*/
|
|
6894
|
-
period
|
|
7595
|
+
period: string;
|
|
6895
7596
|
/**
|
|
6896
7597
|
* Region code for tenant context
|
|
6897
7598
|
*/
|
|
6898
7599
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6899
7600
|
};
|
|
6900
7601
|
|
|
6901
|
-
export type
|
|
6902
|
-
PortfolioTrendsResponseDto;
|
|
7602
|
+
export type DashboardControllerGetCashFlowResponse = CashFlowResponseDto;
|
|
6903
7603
|
|
|
6904
|
-
export type
|
|
7604
|
+
export type DashboardControllerGetExpensesData = {
|
|
6905
7605
|
/**
|
|
6906
|
-
*
|
|
7606
|
+
* Account root to aggregate (expense → ^Expenses:, income → ^Income:)
|
|
6907
7607
|
*/
|
|
6908
|
-
|
|
7608
|
+
flow?: 'expense' | 'income';
|
|
6909
7609
|
/**
|
|
6910
|
-
*
|
|
7610
|
+
* Grouping strategy
|
|
7611
|
+
*/
|
|
7612
|
+
groupBy?: 'category';
|
|
7613
|
+
/**
|
|
7614
|
+
* Time window (1m = current calendar month)
|
|
6911
7615
|
*/
|
|
6912
7616
|
period?: '1m' | '3m' | '6m' | '1y';
|
|
6913
7617
|
/**
|
|
@@ -6916,33 +7620,29 @@ export type ReportingControllerGetCashFlowTrendsData = {
|
|
|
6916
7620
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6917
7621
|
};
|
|
6918
7622
|
|
|
6919
|
-
export type
|
|
6920
|
-
|
|
7623
|
+
export type DashboardControllerGetExpensesResponse =
|
|
7624
|
+
ExpensesByCategoryResponseDto;
|
|
6921
7625
|
|
|
6922
|
-
export type
|
|
7626
|
+
export type HoldingPnlControllerGetHoldingPnlData = {
|
|
6923
7627
|
/**
|
|
6924
|
-
*
|
|
7628
|
+
* Scope to a single account
|
|
6925
7629
|
*/
|
|
6926
|
-
|
|
7630
|
+
accountId?: string;
|
|
6927
7631
|
/**
|
|
6928
|
-
*
|
|
7632
|
+
* As-of date (ISO 8601), defaults to today
|
|
6929
7633
|
*/
|
|
6930
|
-
|
|
6931
|
-
|
|
6932
|
-
|
|
6933
|
-
|
|
6934
|
-
|
|
6935
|
-
|
|
6936
|
-
export type ReportingControllerBackfillSnapshotsData = {
|
|
7634
|
+
asOf?: string;
|
|
7635
|
+
/**
|
|
7636
|
+
* Realized-P&L lot-matching method (default average). Does not affect the average-cost unrealized basis.
|
|
7637
|
+
*/
|
|
7638
|
+
method?: 'FIFO' | 'average';
|
|
6937
7639
|
/**
|
|
6938
7640
|
* Region code for tenant context
|
|
6939
7641
|
*/
|
|
6940
7642
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6941
|
-
requestBody: BackfillSnapshotsBody;
|
|
6942
7643
|
};
|
|
6943
7644
|
|
|
6944
|
-
export type
|
|
6945
|
-
BackfillSnapshotsResponse;
|
|
7645
|
+
export type HoldingPnlControllerGetHoldingPnlResponse = HoldingPnlResponseDto;
|
|
6946
7646
|
|
|
6947
7647
|
export type ApiKeysControllerCreateApiKeyResponse = unknown;
|
|
6948
7648
|
|
|
@@ -6950,7 +7650,7 @@ export type AuthControllerAccessTokenLoginData = {
|
|
|
6950
7650
|
requestBody: AnonymousLoginDto;
|
|
6951
7651
|
};
|
|
6952
7652
|
|
|
6953
|
-
export type AuthControllerAccessTokenLoginResponse =
|
|
7653
|
+
export type AuthControllerAccessTokenLoginResponse = AnonymousLoginResponseDto;
|
|
6954
7654
|
|
|
6955
7655
|
export type CacheControllerFlushCacheResponse = unknown;
|
|
6956
7656
|
|
|
@@ -6990,6 +7690,33 @@ export type HealthControllerGetMetricsResponse = unknown;
|
|
|
6990
7690
|
|
|
6991
7691
|
export type InfoControllerGetInfoResponse = unknown;
|
|
6992
7692
|
|
|
7693
|
+
export type SymbolControllerSearchData = {
|
|
7694
|
+
/**
|
|
7695
|
+
* Filter by OpenBB asset_type (e.g. stock, etf)
|
|
7696
|
+
*/
|
|
7697
|
+
assetType?: string;
|
|
7698
|
+
/**
|
|
7699
|
+
* Filter by exchange code (e.g. US, HK, SS, SZ)
|
|
7700
|
+
*/
|
|
7701
|
+
exchange?: string;
|
|
7702
|
+
/**
|
|
7703
|
+
* Maximum number of results (clamped 1..50)
|
|
7704
|
+
*/
|
|
7705
|
+
limit?: number;
|
|
7706
|
+
/**
|
|
7707
|
+
* Search term — matched against symbol and instrument name. Empty string returns [].
|
|
7708
|
+
*/
|
|
7709
|
+
q: string;
|
|
7710
|
+
};
|
|
7711
|
+
|
|
7712
|
+
export type SymbolControllerSearchResponse = Array<SymbolSearchResultDto>;
|
|
7713
|
+
|
|
7714
|
+
export type SymbolControllerGetQuoteData = {
|
|
7715
|
+
symbol: string;
|
|
7716
|
+
};
|
|
7717
|
+
|
|
7718
|
+
export type SymbolControllerGetQuoteResponse = SymbolQuoteDto;
|
|
7719
|
+
|
|
6993
7720
|
export type $OpenApiTs = {
|
|
6994
7721
|
'/api/v1/{region}/bean/accounts': {
|
|
6995
7722
|
post: {
|
|
@@ -7054,7 +7781,7 @@ export type $OpenApiTs = {
|
|
|
7054
7781
|
*/
|
|
7055
7782
|
404: unknown;
|
|
7056
7783
|
/**
|
|
7057
|
-
* Account has transactions and cannot be deleted
|
|
7784
|
+
* Account has active transactions and cannot be deleted
|
|
7058
7785
|
*/
|
|
7059
7786
|
409: unknown;
|
|
7060
7787
|
};
|
|
@@ -7098,6 +7825,25 @@ export type $OpenApiTs = {
|
|
|
7098
7825
|
};
|
|
7099
7826
|
};
|
|
7100
7827
|
};
|
|
7828
|
+
'/api/v1/{region}/bean/accounts/{id}/opening-balance': {
|
|
7829
|
+
post: {
|
|
7830
|
+
req: AccountControllerAddOpeningBalanceData;
|
|
7831
|
+
res: {
|
|
7832
|
+
/**
|
|
7833
|
+
* Opening-balance transaction created
|
|
7834
|
+
*/
|
|
7835
|
+
201: OpeningBalanceResultDto;
|
|
7836
|
+
/**
|
|
7837
|
+
* Account not found
|
|
7838
|
+
*/
|
|
7839
|
+
404: unknown;
|
|
7840
|
+
/**
|
|
7841
|
+
* An opening balance already exists for this account
|
|
7842
|
+
*/
|
|
7843
|
+
409: unknown;
|
|
7844
|
+
};
|
|
7845
|
+
};
|
|
7846
|
+
};
|
|
7101
7847
|
'/api/v1/{region}/bean/account-standards': {
|
|
7102
7848
|
get: {
|
|
7103
7849
|
req: AccountStandardsControllerGetTemplatesData;
|
|
@@ -7706,6 +8452,90 @@ export type $OpenApiTs = {
|
|
|
7706
8452
|
};
|
|
7707
8453
|
};
|
|
7708
8454
|
};
|
|
8455
|
+
'/api/v1/{region}/bean/prices': {
|
|
8456
|
+
post: {
|
|
8457
|
+
req: PriceControllerCreateData;
|
|
8458
|
+
res: {
|
|
8459
|
+
/**
|
|
8460
|
+
* Price created successfully
|
|
8461
|
+
*/
|
|
8462
|
+
201: PriceResponseDto;
|
|
8463
|
+
/**
|
|
8464
|
+
* Currency or quoteCurrency commodity not found
|
|
8465
|
+
*/
|
|
8466
|
+
404: unknown;
|
|
8467
|
+
/**
|
|
8468
|
+
* Price already exists for this currency pair and date
|
|
8469
|
+
*/
|
|
8470
|
+
409: unknown;
|
|
8471
|
+
};
|
|
8472
|
+
};
|
|
8473
|
+
get: {
|
|
8474
|
+
req: PriceControllerFindAllData;
|
|
8475
|
+
res: {
|
|
8476
|
+
/**
|
|
8477
|
+
* Prices retrieved successfully
|
|
8478
|
+
*/
|
|
8479
|
+
200: PriceListResponseDto;
|
|
8480
|
+
};
|
|
8481
|
+
};
|
|
8482
|
+
};
|
|
8483
|
+
'/api/v1/{region}/bean/prices/{id}': {
|
|
8484
|
+
get: {
|
|
8485
|
+
req: PriceControllerFindOneData;
|
|
8486
|
+
res: {
|
|
8487
|
+
/**
|
|
8488
|
+
* Price retrieved successfully
|
|
8489
|
+
*/
|
|
8490
|
+
200: PriceResponseDto;
|
|
8491
|
+
/**
|
|
8492
|
+
* Price not found
|
|
8493
|
+
*/
|
|
8494
|
+
404: unknown;
|
|
8495
|
+
};
|
|
8496
|
+
};
|
|
8497
|
+
put: {
|
|
8498
|
+
req: PriceControllerUpdateData;
|
|
8499
|
+
res: {
|
|
8500
|
+
/**
|
|
8501
|
+
* Price updated successfully
|
|
8502
|
+
*/
|
|
8503
|
+
200: PriceResponseDto;
|
|
8504
|
+
/**
|
|
8505
|
+
* Price not found
|
|
8506
|
+
*/
|
|
8507
|
+
404: unknown;
|
|
8508
|
+
/**
|
|
8509
|
+
* Updated price conflicts with existing price
|
|
8510
|
+
*/
|
|
8511
|
+
409: unknown;
|
|
8512
|
+
};
|
|
8513
|
+
};
|
|
8514
|
+
delete: {
|
|
8515
|
+
req: PriceControllerDeleteData;
|
|
8516
|
+
res: {
|
|
8517
|
+
/**
|
|
8518
|
+
* Price deleted successfully
|
|
8519
|
+
*/
|
|
8520
|
+
204: void;
|
|
8521
|
+
/**
|
|
8522
|
+
* Price not found
|
|
8523
|
+
*/
|
|
8524
|
+
404: unknown;
|
|
8525
|
+
};
|
|
8526
|
+
};
|
|
8527
|
+
};
|
|
8528
|
+
'/api/v1/{region}/bean/prices/bulk': {
|
|
8529
|
+
post: {
|
|
8530
|
+
req: PriceControllerBulkCreateData;
|
|
8531
|
+
res: {
|
|
8532
|
+
/**
|
|
8533
|
+
* Prices created successfully
|
|
8534
|
+
*/
|
|
8535
|
+
201: Array<PriceResponseDto>;
|
|
8536
|
+
};
|
|
8537
|
+
};
|
|
8538
|
+
};
|
|
7709
8539
|
'/api/v1/{region}/bean/recurring-rules': {
|
|
7710
8540
|
post: {
|
|
7711
8541
|
req: RecurringRuleControllerCreateData;
|
|
@@ -7956,397 +8786,469 @@ export type $OpenApiTs = {
|
|
|
7956
8786
|
};
|
|
7957
8787
|
};
|
|
7958
8788
|
};
|
|
7959
|
-
'/api/v1/{region}/
|
|
8789
|
+
'/api/v1/{region}/reporting/portfolio/trends': {
|
|
8790
|
+
get: {
|
|
8791
|
+
req: ReportingControllerGetPortfolioTrendsData;
|
|
8792
|
+
res: {
|
|
8793
|
+
/**
|
|
8794
|
+
* Trends retrieved successfully
|
|
8795
|
+
*/
|
|
8796
|
+
200: PortfolioTrendsResponseDto;
|
|
8797
|
+
/**
|
|
8798
|
+
* User not authenticated
|
|
8799
|
+
*/
|
|
8800
|
+
401: unknown;
|
|
8801
|
+
};
|
|
8802
|
+
};
|
|
8803
|
+
};
|
|
8804
|
+
'/api/v1/{region}/reporting/cash-flow/trends': {
|
|
8805
|
+
get: {
|
|
8806
|
+
req: ReportingControllerGetCashFlowTrendsData;
|
|
8807
|
+
res: {
|
|
8808
|
+
/**
|
|
8809
|
+
* Cash-flow trends retrieved successfully
|
|
8810
|
+
*/
|
|
8811
|
+
200: CashFlowTrendsResponseDto;
|
|
8812
|
+
/**
|
|
8813
|
+
* User not authenticated
|
|
8814
|
+
*/
|
|
8815
|
+
401: unknown;
|
|
8816
|
+
};
|
|
8817
|
+
};
|
|
8818
|
+
};
|
|
8819
|
+
'/api/v1/{region}/reporting/snapshots/generate': {
|
|
7960
8820
|
post: {
|
|
7961
|
-
req:
|
|
8821
|
+
req: ReportingControllerGenerateSnapshotData;
|
|
7962
8822
|
res: {
|
|
7963
8823
|
/**
|
|
7964
|
-
*
|
|
8824
|
+
* Snapshot generated successfully
|
|
7965
8825
|
*/
|
|
7966
|
-
200:
|
|
8826
|
+
200: GenerateSnapshotResponse;
|
|
7967
8827
|
/**
|
|
7968
|
-
*
|
|
8828
|
+
* Invalid date format
|
|
7969
8829
|
*/
|
|
7970
|
-
400:
|
|
8830
|
+
400: unknown;
|
|
8831
|
+
/**
|
|
8832
|
+
* User not authenticated
|
|
8833
|
+
*/
|
|
8834
|
+
401: unknown;
|
|
8835
|
+
};
|
|
8836
|
+
};
|
|
8837
|
+
};
|
|
8838
|
+
'/api/v1/{region}/reporting/snapshots/backfill': {
|
|
8839
|
+
post: {
|
|
8840
|
+
req: ReportingControllerBackfillSnapshotsData;
|
|
8841
|
+
res: {
|
|
8842
|
+
/**
|
|
8843
|
+
* Backfill completed successfully
|
|
8844
|
+
*/
|
|
8845
|
+
200: BackfillSnapshotsResponse;
|
|
8846
|
+
/**
|
|
8847
|
+
* Invalid date format or range
|
|
8848
|
+
*/
|
|
8849
|
+
400: unknown;
|
|
8850
|
+
/**
|
|
8851
|
+
* User not authenticated
|
|
8852
|
+
*/
|
|
8853
|
+
401: unknown;
|
|
8854
|
+
/**
|
|
8855
|
+
* Backfill already in progress for this user
|
|
8856
|
+
*/
|
|
8857
|
+
409: unknown;
|
|
8858
|
+
};
|
|
8859
|
+
};
|
|
8860
|
+
};
|
|
8861
|
+
'/api/v1/users': {
|
|
8862
|
+
delete: {
|
|
8863
|
+
req: UserControllerDeleteOwnUserData;
|
|
8864
|
+
res: {
|
|
7971
8865
|
/**
|
|
7972
|
-
*
|
|
8866
|
+
* User deleted successfully
|
|
7973
8867
|
*/
|
|
7974
|
-
|
|
8868
|
+
204: void;
|
|
7975
8869
|
/**
|
|
7976
|
-
*
|
|
8870
|
+
* Invalid access token
|
|
7977
8871
|
*/
|
|
7978
|
-
|
|
8872
|
+
403: unknown;
|
|
7979
8873
|
};
|
|
7980
8874
|
};
|
|
7981
8875
|
get: {
|
|
7982
|
-
req:
|
|
8876
|
+
req: UserControllerGetUserData;
|
|
7983
8877
|
res: {
|
|
7984
8878
|
/**
|
|
7985
|
-
*
|
|
7986
|
-
*/
|
|
7987
|
-
200: TransactionRuleListResponseDto;
|
|
7988
|
-
/**
|
|
7989
|
-
* Unauthorized
|
|
8879
|
+
* User retrieved successfully
|
|
7990
8880
|
*/
|
|
7991
|
-
|
|
8881
|
+
200: unknown;
|
|
7992
8882
|
};
|
|
7993
8883
|
};
|
|
7994
|
-
};
|
|
7995
|
-
'/api/v1/{region}/bean/transaction-rules/validate': {
|
|
7996
8884
|
post: {
|
|
7997
|
-
req:
|
|
8885
|
+
req: UserControllerSignupUserData;
|
|
7998
8886
|
res: {
|
|
7999
8887
|
/**
|
|
8000
|
-
*
|
|
8888
|
+
* User created successfully
|
|
8001
8889
|
*/
|
|
8002
|
-
|
|
8890
|
+
201: SignupResponseDto;
|
|
8003
8891
|
/**
|
|
8004
|
-
*
|
|
8892
|
+
* Invalid Turnstile token (when Turnstile is enabled)
|
|
8005
8893
|
*/
|
|
8006
|
-
400:
|
|
8894
|
+
400: unknown;
|
|
8007
8895
|
/**
|
|
8008
|
-
*
|
|
8896
|
+
* User signup is disabled
|
|
8009
8897
|
*/
|
|
8010
|
-
|
|
8898
|
+
403: unknown;
|
|
8011
8899
|
};
|
|
8012
8900
|
};
|
|
8013
8901
|
};
|
|
8014
|
-
'/api/v1/{
|
|
8015
|
-
|
|
8016
|
-
req:
|
|
8902
|
+
'/api/v1/users/{id}': {
|
|
8903
|
+
delete: {
|
|
8904
|
+
req: UserControllerDeleteUserData;
|
|
8017
8905
|
res: {
|
|
8018
8906
|
/**
|
|
8019
|
-
*
|
|
8020
|
-
*/
|
|
8021
|
-
201: BulkCreateRulesResponseDto;
|
|
8022
|
-
/**
|
|
8023
|
-
* Invalid bulk create data
|
|
8907
|
+
* User deleted successfully
|
|
8024
8908
|
*/
|
|
8025
|
-
|
|
8909
|
+
204: void;
|
|
8026
8910
|
/**
|
|
8027
|
-
*
|
|
8911
|
+
* Cannot delete own account or insufficient permissions
|
|
8028
8912
|
*/
|
|
8029
|
-
|
|
8913
|
+
403: unknown;
|
|
8030
8914
|
};
|
|
8031
8915
|
};
|
|
8032
8916
|
};
|
|
8033
|
-
'/api/v1/{
|
|
8917
|
+
'/api/v1/users/{id}/info': {
|
|
8034
8918
|
get: {
|
|
8035
|
-
req:
|
|
8919
|
+
req: UserControllerGetUserInfoData;
|
|
8036
8920
|
res: {
|
|
8037
8921
|
/**
|
|
8038
|
-
*
|
|
8039
|
-
*/
|
|
8040
|
-
200: ExportRulesResponseDto;
|
|
8041
|
-
/**
|
|
8042
|
-
* Unsupported format
|
|
8922
|
+
* User info retrieved successfully
|
|
8043
8923
|
*/
|
|
8044
|
-
|
|
8924
|
+
200: unknown;
|
|
8045
8925
|
/**
|
|
8046
|
-
*
|
|
8926
|
+
* Cannot access other user info without admin permission
|
|
8047
8927
|
*/
|
|
8048
|
-
|
|
8928
|
+
403: unknown;
|
|
8049
8929
|
};
|
|
8050
8930
|
};
|
|
8051
8931
|
};
|
|
8052
|
-
'/api/v1/
|
|
8053
|
-
|
|
8054
|
-
req:
|
|
8932
|
+
'/api/v1/users/setting': {
|
|
8933
|
+
put: {
|
|
8934
|
+
req: UserControllerUpdateUserSettingData;
|
|
8055
8935
|
res: {
|
|
8056
8936
|
/**
|
|
8057
|
-
*
|
|
8937
|
+
* Settings updated successfully
|
|
8058
8938
|
*/
|
|
8059
|
-
200:
|
|
8939
|
+
200: unknown;
|
|
8060
8940
|
/**
|
|
8061
|
-
*
|
|
8941
|
+
* Insufficient permissions
|
|
8062
8942
|
*/
|
|
8063
|
-
|
|
8943
|
+
403: unknown;
|
|
8064
8944
|
};
|
|
8065
8945
|
};
|
|
8066
8946
|
};
|
|
8067
|
-
'/api/v1/
|
|
8947
|
+
'/api/v1/users/settings-by-page': {
|
|
8068
8948
|
get: {
|
|
8069
|
-
req:
|
|
8949
|
+
req: UserControllerGetAllUserSettingsByPageData;
|
|
8070
8950
|
res: {
|
|
8071
8951
|
/**
|
|
8072
|
-
*
|
|
8073
|
-
*/
|
|
8074
|
-
200: TransactionRuleResponseDto;
|
|
8075
|
-
/**
|
|
8076
|
-
* Unauthorized
|
|
8077
|
-
*/
|
|
8078
|
-
401: ApiProblemResponseDto;
|
|
8079
|
-
/**
|
|
8080
|
-
* Forbidden - not owner of rule
|
|
8081
|
-
*/
|
|
8082
|
-
403: ApiProblemResponseDto;
|
|
8083
|
-
/**
|
|
8084
|
-
* Rule not found
|
|
8952
|
+
* Settings list retrieved successfully
|
|
8085
8953
|
*/
|
|
8086
|
-
|
|
8954
|
+
200: unknown;
|
|
8087
8955
|
};
|
|
8088
8956
|
};
|
|
8089
|
-
|
|
8090
|
-
|
|
8957
|
+
};
|
|
8958
|
+
'/api/v1/users/asset-liability-summary': {
|
|
8959
|
+
get: {
|
|
8091
8960
|
res: {
|
|
8092
8961
|
/**
|
|
8093
|
-
*
|
|
8962
|
+
* Summary retrieved successfully
|
|
8094
8963
|
*/
|
|
8095
|
-
200:
|
|
8964
|
+
200: unknown;
|
|
8965
|
+
};
|
|
8966
|
+
};
|
|
8967
|
+
};
|
|
8968
|
+
'/api/v1/admin/properties': {
|
|
8969
|
+
get: {
|
|
8970
|
+
res: {
|
|
8096
8971
|
/**
|
|
8097
|
-
*
|
|
8972
|
+
* Properties retrieved successfully
|
|
8098
8973
|
*/
|
|
8099
|
-
|
|
8974
|
+
200: unknown;
|
|
8100
8975
|
/**
|
|
8101
8976
|
* Unauthorized
|
|
8102
8977
|
*/
|
|
8103
|
-
401:
|
|
8104
|
-
/**
|
|
8105
|
-
* Forbidden - not owner of rule
|
|
8106
|
-
*/
|
|
8107
|
-
403: ApiProblemResponseDto;
|
|
8108
|
-
/**
|
|
8109
|
-
* Rule not found
|
|
8110
|
-
*/
|
|
8111
|
-
404: ApiProblemResponseDto;
|
|
8978
|
+
401: unknown;
|
|
8112
8979
|
/**
|
|
8113
|
-
*
|
|
8980
|
+
* Forbidden - insufficient permissions
|
|
8114
8981
|
*/
|
|
8115
|
-
|
|
8982
|
+
403: unknown;
|
|
8116
8983
|
};
|
|
8117
8984
|
};
|
|
8118
|
-
|
|
8119
|
-
|
|
8985
|
+
};
|
|
8986
|
+
'/api/v1/admin/properties/{key}': {
|
|
8987
|
+
get: {
|
|
8988
|
+
req: PropertyControllerGetByKeyData;
|
|
8120
8989
|
res: {
|
|
8121
8990
|
/**
|
|
8122
|
-
*
|
|
8991
|
+
* Property retrieved successfully
|
|
8123
8992
|
*/
|
|
8124
|
-
|
|
8993
|
+
200: unknown;
|
|
8125
8994
|
/**
|
|
8126
8995
|
* Unauthorized
|
|
8127
8996
|
*/
|
|
8128
|
-
401:
|
|
8129
|
-
/**
|
|
8130
|
-
* Forbidden - not owner of rule
|
|
8131
|
-
*/
|
|
8132
|
-
403: ApiProblemResponseDto;
|
|
8997
|
+
401: unknown;
|
|
8133
8998
|
/**
|
|
8134
|
-
*
|
|
8999
|
+
* Forbidden - insufficient permissions
|
|
8135
9000
|
*/
|
|
8136
|
-
|
|
9001
|
+
403: unknown;
|
|
8137
9002
|
/**
|
|
8138
|
-
*
|
|
9003
|
+
* Property not found
|
|
8139
9004
|
*/
|
|
8140
|
-
|
|
9005
|
+
404: unknown;
|
|
8141
9006
|
};
|
|
8142
9007
|
};
|
|
8143
|
-
|
|
8144
|
-
|
|
8145
|
-
post: {
|
|
8146
|
-
req: TransactionRuleControllerTestData;
|
|
9008
|
+
put: {
|
|
9009
|
+
req: PropertyControllerUpdateData;
|
|
8147
9010
|
res: {
|
|
8148
9011
|
/**
|
|
8149
|
-
*
|
|
9012
|
+
* Property updated successfully
|
|
8150
9013
|
*/
|
|
8151
|
-
200:
|
|
9014
|
+
200: unknown;
|
|
8152
9015
|
/**
|
|
8153
9016
|
* Unauthorized
|
|
8154
9017
|
*/
|
|
8155
|
-
401:
|
|
8156
|
-
/**
|
|
8157
|
-
* Forbidden - not owner of rule
|
|
8158
|
-
*/
|
|
8159
|
-
403: ApiProblemResponseDto;
|
|
9018
|
+
401: unknown;
|
|
8160
9019
|
/**
|
|
8161
|
-
*
|
|
9020
|
+
* Forbidden - insufficient permissions
|
|
8162
9021
|
*/
|
|
8163
|
-
|
|
9022
|
+
403: unknown;
|
|
8164
9023
|
};
|
|
8165
9024
|
};
|
|
8166
|
-
};
|
|
8167
|
-
'/api/v1/users': {
|
|
8168
9025
|
delete: {
|
|
8169
|
-
req:
|
|
9026
|
+
req: PropertyControllerDeleteData;
|
|
8170
9027
|
res: {
|
|
8171
9028
|
/**
|
|
8172
|
-
*
|
|
9029
|
+
* Property deleted successfully
|
|
8173
9030
|
*/
|
|
8174
9031
|
204: void;
|
|
8175
9032
|
/**
|
|
8176
|
-
*
|
|
9033
|
+
* Unauthorized
|
|
9034
|
+
*/
|
|
9035
|
+
401: unknown;
|
|
9036
|
+
/**
|
|
9037
|
+
* Forbidden - insufficient permissions
|
|
8177
9038
|
*/
|
|
8178
9039
|
403: unknown;
|
|
8179
|
-
};
|
|
8180
|
-
};
|
|
8181
|
-
get: {
|
|
8182
|
-
req: UserControllerGetUserData;
|
|
8183
|
-
res: {
|
|
8184
9040
|
/**
|
|
8185
|
-
*
|
|
9041
|
+
* Property not found
|
|
8186
9042
|
*/
|
|
8187
|
-
|
|
9043
|
+
404: unknown;
|
|
8188
9044
|
};
|
|
8189
9045
|
};
|
|
9046
|
+
};
|
|
9047
|
+
'/api/v1/{region}/bean/transaction-rules': {
|
|
8190
9048
|
post: {
|
|
8191
|
-
req:
|
|
9049
|
+
req: TransactionRuleControllerCreateData;
|
|
8192
9050
|
res: {
|
|
8193
9051
|
/**
|
|
8194
|
-
*
|
|
9052
|
+
* Rule updated successfully (upsert mode)
|
|
8195
9053
|
*/
|
|
8196
|
-
|
|
9054
|
+
200: TransactionRuleResponseDto;
|
|
8197
9055
|
/**
|
|
8198
|
-
*
|
|
9056
|
+
* Validation failed
|
|
8199
9057
|
*/
|
|
8200
|
-
400:
|
|
9058
|
+
400: ApiProblemResponseDto;
|
|
8201
9059
|
/**
|
|
8202
|
-
*
|
|
9060
|
+
* Unauthorized
|
|
8203
9061
|
*/
|
|
8204
|
-
|
|
9062
|
+
401: ApiProblemResponseDto;
|
|
9063
|
+
/**
|
|
9064
|
+
* Resource conflict - another process is updating this rule
|
|
9065
|
+
*/
|
|
9066
|
+
409: ApiProblemResponseDto;
|
|
8205
9067
|
};
|
|
8206
9068
|
};
|
|
8207
|
-
|
|
8208
|
-
|
|
8209
|
-
delete: {
|
|
8210
|
-
req: UserControllerDeleteUserData;
|
|
9069
|
+
get: {
|
|
9070
|
+
req: TransactionRuleControllerListData;
|
|
8211
9071
|
res: {
|
|
8212
9072
|
/**
|
|
8213
|
-
*
|
|
9073
|
+
* List of rules
|
|
8214
9074
|
*/
|
|
8215
|
-
|
|
9075
|
+
200: TransactionRuleListResponseDto;
|
|
8216
9076
|
/**
|
|
8217
|
-
*
|
|
9077
|
+
* Unauthorized
|
|
8218
9078
|
*/
|
|
8219
|
-
|
|
9079
|
+
401: ApiProblemResponseDto;
|
|
8220
9080
|
};
|
|
8221
9081
|
};
|
|
8222
9082
|
};
|
|
8223
|
-
'/api/v1/
|
|
8224
|
-
|
|
8225
|
-
req:
|
|
9083
|
+
'/api/v1/{region}/bean/transaction-rules/validate': {
|
|
9084
|
+
post: {
|
|
9085
|
+
req: TransactionRuleControllerValidateData;
|
|
8226
9086
|
res: {
|
|
8227
9087
|
/**
|
|
8228
|
-
*
|
|
9088
|
+
* Validation result
|
|
8229
9089
|
*/
|
|
8230
|
-
200:
|
|
9090
|
+
200: ValidateRuleResponseDto;
|
|
8231
9091
|
/**
|
|
8232
|
-
*
|
|
9092
|
+
* Validation failed
|
|
8233
9093
|
*/
|
|
8234
|
-
|
|
9094
|
+
400: ApiProblemResponseDto;
|
|
9095
|
+
/**
|
|
9096
|
+
* Unauthorized
|
|
9097
|
+
*/
|
|
9098
|
+
401: ApiProblemResponseDto;
|
|
8235
9099
|
};
|
|
8236
9100
|
};
|
|
8237
9101
|
};
|
|
8238
|
-
'/api/v1/
|
|
8239
|
-
|
|
8240
|
-
req:
|
|
9102
|
+
'/api/v1/{region}/bean/transaction-rules/bulk': {
|
|
9103
|
+
post: {
|
|
9104
|
+
req: TransactionRuleControllerBulkCreateData;
|
|
8241
9105
|
res: {
|
|
8242
9106
|
/**
|
|
8243
|
-
*
|
|
9107
|
+
* Bulk create completed
|
|
8244
9108
|
*/
|
|
8245
|
-
|
|
9109
|
+
201: BulkCreateRulesResponseDto;
|
|
8246
9110
|
/**
|
|
8247
|
-
*
|
|
9111
|
+
* Invalid bulk create data
|
|
8248
9112
|
*/
|
|
8249
|
-
|
|
9113
|
+
400: ApiProblemResponseDto;
|
|
9114
|
+
/**
|
|
9115
|
+
* Unauthorized
|
|
9116
|
+
*/
|
|
9117
|
+
401: ApiProblemResponseDto;
|
|
8250
9118
|
};
|
|
8251
9119
|
};
|
|
8252
9120
|
};
|
|
8253
|
-
'/api/v1/
|
|
9121
|
+
'/api/v1/{region}/bean/transaction-rules/export/{format}': {
|
|
8254
9122
|
get: {
|
|
8255
|
-
req:
|
|
9123
|
+
req: TransactionRuleControllerExportData;
|
|
8256
9124
|
res: {
|
|
8257
9125
|
/**
|
|
8258
|
-
*
|
|
9126
|
+
* Exported rules
|
|
8259
9127
|
*/
|
|
8260
|
-
200:
|
|
9128
|
+
200: ExportRulesResponseDto;
|
|
9129
|
+
/**
|
|
9130
|
+
* Unsupported format
|
|
9131
|
+
*/
|
|
9132
|
+
400: ApiProblemResponseDto;
|
|
9133
|
+
/**
|
|
9134
|
+
* Unauthorized
|
|
9135
|
+
*/
|
|
9136
|
+
401: ApiProblemResponseDto;
|
|
8261
9137
|
};
|
|
8262
9138
|
};
|
|
8263
9139
|
};
|
|
8264
|
-
'/api/v1/
|
|
9140
|
+
'/api/v1/{region}/bean/transaction-rules/statistics/{period}': {
|
|
8265
9141
|
get: {
|
|
9142
|
+
req: TransactionRuleControllerGetStatisticsData;
|
|
8266
9143
|
res: {
|
|
8267
9144
|
/**
|
|
8268
|
-
*
|
|
9145
|
+
* Rule statistics
|
|
8269
9146
|
*/
|
|
8270
|
-
200:
|
|
9147
|
+
200: RuleStatisticsResponseDto;
|
|
9148
|
+
/**
|
|
9149
|
+
* Unauthorized
|
|
9150
|
+
*/
|
|
9151
|
+
401: ApiProblemResponseDto;
|
|
8271
9152
|
};
|
|
8272
9153
|
};
|
|
8273
9154
|
};
|
|
8274
|
-
'/api/v1/
|
|
9155
|
+
'/api/v1/{region}/bean/transaction-rules/{ruleId}': {
|
|
8275
9156
|
get: {
|
|
9157
|
+
req: TransactionRuleControllerGetDetailData;
|
|
8276
9158
|
res: {
|
|
8277
9159
|
/**
|
|
8278
|
-
*
|
|
9160
|
+
* Rule details
|
|
8279
9161
|
*/
|
|
8280
|
-
200:
|
|
9162
|
+
200: TransactionRuleResponseDto;
|
|
8281
9163
|
/**
|
|
8282
9164
|
* Unauthorized
|
|
8283
9165
|
*/
|
|
8284
|
-
401:
|
|
9166
|
+
401: ApiProblemResponseDto;
|
|
8285
9167
|
/**
|
|
8286
|
-
* Forbidden -
|
|
9168
|
+
* Forbidden - not owner of rule
|
|
8287
9169
|
*/
|
|
8288
|
-
403:
|
|
9170
|
+
403: ApiProblemResponseDto;
|
|
9171
|
+
/**
|
|
9172
|
+
* Rule not found
|
|
9173
|
+
*/
|
|
9174
|
+
404: ApiProblemResponseDto;
|
|
8289
9175
|
};
|
|
8290
9176
|
};
|
|
8291
|
-
|
|
8292
|
-
|
|
8293
|
-
get: {
|
|
8294
|
-
req: PropertyControllerGetByKeyData;
|
|
9177
|
+
put: {
|
|
9178
|
+
req: TransactionRuleControllerUpdateData;
|
|
8295
9179
|
res: {
|
|
8296
9180
|
/**
|
|
8297
|
-
*
|
|
9181
|
+
* Rule updated successfully
|
|
8298
9182
|
*/
|
|
8299
|
-
200:
|
|
9183
|
+
200: TransactionRuleResponseDto;
|
|
9184
|
+
/**
|
|
9185
|
+
* Validation failed
|
|
9186
|
+
*/
|
|
9187
|
+
400: ApiProblemResponseDto;
|
|
8300
9188
|
/**
|
|
8301
9189
|
* Unauthorized
|
|
8302
9190
|
*/
|
|
8303
|
-
401:
|
|
9191
|
+
401: ApiProblemResponseDto;
|
|
8304
9192
|
/**
|
|
8305
|
-
* Forbidden -
|
|
9193
|
+
* Forbidden - not owner of rule
|
|
8306
9194
|
*/
|
|
8307
|
-
403:
|
|
9195
|
+
403: ApiProblemResponseDto;
|
|
8308
9196
|
/**
|
|
8309
|
-
*
|
|
9197
|
+
* Rule not found
|
|
8310
9198
|
*/
|
|
8311
|
-
404:
|
|
9199
|
+
404: ApiProblemResponseDto;
|
|
9200
|
+
/**
|
|
9201
|
+
* Resource conflict - rule is being modified by another process
|
|
9202
|
+
*/
|
|
9203
|
+
409: ApiProblemResponseDto;
|
|
8312
9204
|
};
|
|
8313
9205
|
};
|
|
8314
|
-
|
|
8315
|
-
req:
|
|
9206
|
+
delete: {
|
|
9207
|
+
req: TransactionRuleControllerDeleteData;
|
|
8316
9208
|
res: {
|
|
8317
9209
|
/**
|
|
8318
|
-
*
|
|
9210
|
+
* Rule deleted successfully
|
|
8319
9211
|
*/
|
|
8320
|
-
|
|
9212
|
+
204: void;
|
|
8321
9213
|
/**
|
|
8322
9214
|
* Unauthorized
|
|
8323
9215
|
*/
|
|
8324
|
-
401:
|
|
9216
|
+
401: ApiProblemResponseDto;
|
|
8325
9217
|
/**
|
|
8326
|
-
* Forbidden -
|
|
9218
|
+
* Forbidden - not owner of rule
|
|
8327
9219
|
*/
|
|
8328
|
-
403:
|
|
9220
|
+
403: ApiProblemResponseDto;
|
|
9221
|
+
/**
|
|
9222
|
+
* Rule not found
|
|
9223
|
+
*/
|
|
9224
|
+
404: ApiProblemResponseDto;
|
|
9225
|
+
/**
|
|
9226
|
+
* Resource conflict - rule is being modified by another process
|
|
9227
|
+
*/
|
|
9228
|
+
409: ApiProblemResponseDto;
|
|
8329
9229
|
};
|
|
8330
9230
|
};
|
|
8331
|
-
|
|
8332
|
-
|
|
9231
|
+
};
|
|
9232
|
+
'/api/v1/{region}/bean/transaction-rules/{ruleId}/test': {
|
|
9233
|
+
post: {
|
|
9234
|
+
req: TransactionRuleControllerTestData;
|
|
8333
9235
|
res: {
|
|
8334
9236
|
/**
|
|
8335
|
-
*
|
|
9237
|
+
* Test result
|
|
8336
9238
|
*/
|
|
8337
|
-
|
|
9239
|
+
200: TestRuleResponseDto;
|
|
8338
9240
|
/**
|
|
8339
9241
|
* Unauthorized
|
|
8340
9242
|
*/
|
|
8341
|
-
401:
|
|
9243
|
+
401: ApiProblemResponseDto;
|
|
8342
9244
|
/**
|
|
8343
|
-
* Forbidden -
|
|
9245
|
+
* Forbidden - not owner of rule
|
|
8344
9246
|
*/
|
|
8345
|
-
403:
|
|
9247
|
+
403: ApiProblemResponseDto;
|
|
8346
9248
|
/**
|
|
8347
|
-
*
|
|
9249
|
+
* Rule not found
|
|
8348
9250
|
*/
|
|
8349
|
-
404:
|
|
9251
|
+
404: ApiProblemResponseDto;
|
|
8350
9252
|
};
|
|
8351
9253
|
};
|
|
8352
9254
|
};
|
|
@@ -8446,6 +9348,85 @@ export type $OpenApiTs = {
|
|
|
8446
9348
|
};
|
|
8447
9349
|
};
|
|
8448
9350
|
};
|
|
9351
|
+
'/api/v1/{region}/bean/onboarding': {
|
|
9352
|
+
post: {
|
|
9353
|
+
req: OnboardingControllerBootstrapData;
|
|
9354
|
+
res: {
|
|
9355
|
+
/**
|
|
9356
|
+
* Onboarding bootstrap result.
|
|
9357
|
+
*/
|
|
9358
|
+
201: unknown;
|
|
9359
|
+
/**
|
|
9360
|
+
* Invalid region/account path/duplicate paths.
|
|
9361
|
+
*/
|
|
9362
|
+
422: unknown;
|
|
9363
|
+
};
|
|
9364
|
+
};
|
|
9365
|
+
};
|
|
9366
|
+
'/api/v1/{region}/bean/reconciliations': {
|
|
9367
|
+
post: {
|
|
9368
|
+
req: ReconciliationControllerComputeData;
|
|
9369
|
+
res: {
|
|
9370
|
+
/**
|
|
9371
|
+
* Reconciliation preview
|
|
9372
|
+
*/
|
|
9373
|
+
200: ReconciliationComputeResultDto;
|
|
9374
|
+
/**
|
|
9375
|
+
* Account not found
|
|
9376
|
+
*/
|
|
9377
|
+
404: unknown;
|
|
9378
|
+
};
|
|
9379
|
+
};
|
|
9380
|
+
};
|
|
9381
|
+
'/api/v1/{region}/bean/reconciliations/assert': {
|
|
9382
|
+
post: {
|
|
9383
|
+
req: ReconciliationControllerAssertData;
|
|
9384
|
+
res: {
|
|
9385
|
+
/**
|
|
9386
|
+
* Balance assertion recorded
|
|
9387
|
+
*/
|
|
9388
|
+
201: ReconciliationRecordDto;
|
|
9389
|
+
/**
|
|
9390
|
+
* Account not found
|
|
9391
|
+
*/
|
|
9392
|
+
404: unknown;
|
|
9393
|
+
};
|
|
9394
|
+
};
|
|
9395
|
+
};
|
|
9396
|
+
'/api/v1/{region}/bean/reconciliations/pad': {
|
|
9397
|
+
post: {
|
|
9398
|
+
req: ReconciliationControllerPadData;
|
|
9399
|
+
res: {
|
|
9400
|
+
/**
|
|
9401
|
+
* Pad adjusting entry generated
|
|
9402
|
+
*/
|
|
9403
|
+
201: PadResultDto;
|
|
9404
|
+
/**
|
|
9405
|
+
* Book already within tolerance — no pad needed
|
|
9406
|
+
*/
|
|
9407
|
+
400: unknown;
|
|
9408
|
+
/**
|
|
9409
|
+
* Account not found
|
|
9410
|
+
*/
|
|
9411
|
+
404: unknown;
|
|
9412
|
+
};
|
|
9413
|
+
};
|
|
9414
|
+
};
|
|
9415
|
+
'/api/v1/{region}/bean/accounts/{accountId}/reconciliations': {
|
|
9416
|
+
get: {
|
|
9417
|
+
req: ReconciliationControllerHistoryData;
|
|
9418
|
+
res: {
|
|
9419
|
+
/**
|
|
9420
|
+
* Reconciliation history
|
|
9421
|
+
*/
|
|
9422
|
+
200: Array<ReconciliationRecordDto>;
|
|
9423
|
+
/**
|
|
9424
|
+
* Account not found
|
|
9425
|
+
*/
|
|
9426
|
+
404: unknown;
|
|
9427
|
+
};
|
|
9428
|
+
};
|
|
9429
|
+
};
|
|
8449
9430
|
'/api/v1/{region}/bean/export/beancount': {
|
|
8450
9431
|
get: {
|
|
8451
9432
|
res: {
|
|
@@ -8588,83 +9569,11 @@ export type $OpenApiTs = {
|
|
|
8588
9569
|
/**
|
|
8589
9570
|
* Configuration reset successfully
|
|
8590
9571
|
*/
|
|
8591
|
-
200: ImporterConfigDto;
|
|
8592
|
-
/**
|
|
8593
|
-
* Invalid input - Unsupported importer
|
|
8594
|
-
*/
|
|
8595
|
-
400: ApiProblemResponseDto;
|
|
8596
|
-
};
|
|
8597
|
-
};
|
|
8598
|
-
};
|
|
8599
|
-
'/api/v1/bean/platforms': {
|
|
8600
|
-
get: {
|
|
8601
|
-
res: {
|
|
8602
|
-
/**
|
|
8603
|
-
* List of platforms with binding and account counts
|
|
8604
|
-
*/
|
|
8605
|
-
200: unknown;
|
|
8606
|
-
};
|
|
8607
|
-
};
|
|
8608
|
-
post: {
|
|
8609
|
-
req: PlatformControllerCreateData;
|
|
8610
|
-
res: {
|
|
8611
|
-
/**
|
|
8612
|
-
* Platform created successfully
|
|
8613
|
-
*/
|
|
8614
|
-
201: unknown;
|
|
8615
|
-
/**
|
|
8616
|
-
* Platform already exists
|
|
8617
|
-
*/
|
|
8618
|
-
409: unknown;
|
|
8619
|
-
};
|
|
8620
|
-
};
|
|
8621
|
-
};
|
|
8622
|
-
'/api/v1/bean/platforms/list': {
|
|
8623
|
-
get: {
|
|
8624
|
-
res: {
|
|
8625
|
-
/**
|
|
8626
|
-
* List of platforms with user binding status
|
|
8627
|
-
*/
|
|
8628
|
-
200: unknown;
|
|
8629
|
-
};
|
|
8630
|
-
};
|
|
8631
|
-
};
|
|
8632
|
-
'/api/v1/bean/platforms/match': {
|
|
8633
|
-
get: {
|
|
8634
|
-
req: PlatformControllerMatchPlatformsData;
|
|
8635
|
-
res: {
|
|
8636
|
-
/**
|
|
8637
|
-
* List of matching platforms with suggested segment names
|
|
8638
|
-
*/
|
|
8639
|
-
200: unknown;
|
|
8640
|
-
};
|
|
8641
|
-
};
|
|
8642
|
-
};
|
|
8643
|
-
'/api/v1/bean/platforms/{id}': {
|
|
8644
|
-
put: {
|
|
8645
|
-
req: PlatformControllerUpdateData;
|
|
8646
|
-
res: {
|
|
8647
|
-
/**
|
|
8648
|
-
* Platform updated successfully
|
|
8649
|
-
*/
|
|
8650
|
-
200: unknown;
|
|
8651
|
-
/**
|
|
8652
|
-
* Platform not found
|
|
8653
|
-
*/
|
|
8654
|
-
404: unknown;
|
|
8655
|
-
};
|
|
8656
|
-
};
|
|
8657
|
-
delete: {
|
|
8658
|
-
req: PlatformControllerDeleteData;
|
|
8659
|
-
res: {
|
|
8660
|
-
/**
|
|
8661
|
-
* Platform deleted successfully
|
|
8662
|
-
*/
|
|
8663
|
-
204: void;
|
|
9572
|
+
200: ImporterConfigDto;
|
|
8664
9573
|
/**
|
|
8665
|
-
*
|
|
9574
|
+
* Invalid input - Unsupported importer
|
|
8666
9575
|
*/
|
|
8667
|
-
|
|
9576
|
+
400: ApiProblemResponseDto;
|
|
8668
9577
|
};
|
|
8669
9578
|
};
|
|
8670
9579
|
};
|
|
@@ -8721,6 +9630,54 @@ export type $OpenApiTs = {
|
|
|
8721
9630
|
};
|
|
8722
9631
|
};
|
|
8723
9632
|
};
|
|
9633
|
+
'/api/v1/{region}/bean/external-account-links': {
|
|
9634
|
+
post: {
|
|
9635
|
+
req: ExternalAccountLinkControllerCreateData;
|
|
9636
|
+
res: {
|
|
9637
|
+
/**
|
|
9638
|
+
* Link created.
|
|
9639
|
+
*/
|
|
9640
|
+
201: ExternalAccountLinkResponseDto;
|
|
9641
|
+
/**
|
|
9642
|
+
* beanAccountId not owned, or an active link already exists.
|
|
9643
|
+
*/
|
|
9644
|
+
422: unknown;
|
|
9645
|
+
};
|
|
9646
|
+
};
|
|
9647
|
+
get: {
|
|
9648
|
+
req: ExternalAccountLinkControllerFindAllData;
|
|
9649
|
+
res: {
|
|
9650
|
+
/**
|
|
9651
|
+
* Links retrieved.
|
|
9652
|
+
*/
|
|
9653
|
+
200: ExternalAccountLinkListResponseDto;
|
|
9654
|
+
};
|
|
9655
|
+
};
|
|
9656
|
+
};
|
|
9657
|
+
'/api/v1/{region}/bean/external-account-links/{id}': {
|
|
9658
|
+
get: {
|
|
9659
|
+
req: ExternalAccountLinkControllerFindOneData;
|
|
9660
|
+
res: {
|
|
9661
|
+
/**
|
|
9662
|
+
* Link retrieved.
|
|
9663
|
+
*/
|
|
9664
|
+
200: ExternalAccountLinkResponseDto;
|
|
9665
|
+
/**
|
|
9666
|
+
* Link not found or not owned by the user.
|
|
9667
|
+
*/
|
|
9668
|
+
422: unknown;
|
|
9669
|
+
};
|
|
9670
|
+
};
|
|
9671
|
+
delete: {
|
|
9672
|
+
req: ExternalAccountLinkControllerRemoveData;
|
|
9673
|
+
res: {
|
|
9674
|
+
/**
|
|
9675
|
+
* Link soft-deleted; historical transactions are unaffected.
|
|
9676
|
+
*/
|
|
9677
|
+
204: void;
|
|
9678
|
+
};
|
|
9679
|
+
};
|
|
9680
|
+
};
|
|
8724
9681
|
'/api/v1/{region}/bean/import/parser-telemetry': {
|
|
8725
9682
|
post: {
|
|
8726
9683
|
req: TelemetryControllerReportTelemetryData;
|
|
@@ -8809,188 +9766,104 @@ export type $OpenApiTs = {
|
|
|
8809
9766
|
};
|
|
8810
9767
|
};
|
|
8811
9768
|
};
|
|
8812
|
-
'/api/v1/
|
|
8813
|
-
get: {
|
|
8814
|
-
req: DashboardControllerGetNetWorthData;
|
|
8815
|
-
res: {
|
|
8816
|
-
/**
|
|
8817
|
-
* Net worth retrieved successfully
|
|
8818
|
-
*/
|
|
8819
|
-
200: NetWorthResponseDto;
|
|
8820
|
-
/**
|
|
8821
|
-
* User not authenticated
|
|
8822
|
-
*/
|
|
8823
|
-
401: unknown;
|
|
8824
|
-
};
|
|
8825
|
-
};
|
|
8826
|
-
};
|
|
8827
|
-
'/api/v1/{region}/dashboard/accounts': {
|
|
8828
|
-
get: {
|
|
8829
|
-
req: DashboardControllerGetAccountsData;
|
|
8830
|
-
res: {
|
|
8831
|
-
/**
|
|
8832
|
-
* Accounts retrieved successfully. Response type depends on groupBy parameter.
|
|
8833
|
-
*/
|
|
8834
|
-
200:
|
|
8835
|
-
| AccountsResponseDto
|
|
8836
|
-
| AssetClassAccountsResponseDto
|
|
8837
|
-
| HoldingAssetClassCrossAccountResponseDto;
|
|
8838
|
-
/**
|
|
8839
|
-
* User not authenticated
|
|
8840
|
-
*/
|
|
8841
|
-
401: unknown;
|
|
8842
|
-
};
|
|
8843
|
-
};
|
|
8844
|
-
};
|
|
8845
|
-
'/api/v1/{region}/dashboard/cash-flow': {
|
|
8846
|
-
get: {
|
|
8847
|
-
req: DashboardControllerGetCashFlowData;
|
|
8848
|
-
res: {
|
|
8849
|
-
/**
|
|
8850
|
-
* Cash flow retrieved successfully
|
|
8851
|
-
*/
|
|
8852
|
-
200: CashFlowResponseDto;
|
|
8853
|
-
/**
|
|
8854
|
-
* Invalid period format
|
|
8855
|
-
*/
|
|
8856
|
-
400: unknown;
|
|
8857
|
-
/**
|
|
8858
|
-
* User not authenticated
|
|
8859
|
-
*/
|
|
8860
|
-
401: unknown;
|
|
8861
|
-
};
|
|
8862
|
-
};
|
|
8863
|
-
};
|
|
8864
|
-
'/api/v1/{region}/dashboard/expenses': {
|
|
8865
|
-
get: {
|
|
8866
|
-
req: DashboardControllerGetExpensesData;
|
|
8867
|
-
res: {
|
|
8868
|
-
/**
|
|
8869
|
-
* Expenses retrieved successfully
|
|
8870
|
-
*/
|
|
8871
|
-
200: ExpensesByCategoryResponseDto;
|
|
8872
|
-
/**
|
|
8873
|
-
* Invalid groupBy or period
|
|
8874
|
-
*/
|
|
8875
|
-
400: unknown;
|
|
8876
|
-
/**
|
|
8877
|
-
* User not authenticated
|
|
8878
|
-
*/
|
|
8879
|
-
401: unknown;
|
|
8880
|
-
};
|
|
8881
|
-
};
|
|
8882
|
-
};
|
|
8883
|
-
'/api/v1/{region}/investment/holdings/pnl': {
|
|
9769
|
+
'/api/v1/bean/platforms': {
|
|
8884
9770
|
get: {
|
|
8885
|
-
req: HoldingPnlControllerGetHoldingPnlData;
|
|
8886
9771
|
res: {
|
|
8887
9772
|
/**
|
|
8888
|
-
*
|
|
8889
|
-
*/
|
|
8890
|
-
200: HoldingPnlResponseDto;
|
|
8891
|
-
/**
|
|
8892
|
-
* Invalid asOf format/value/future date, invalid accountId format, or unsupported method
|
|
8893
|
-
*/
|
|
8894
|
-
400: unknown;
|
|
8895
|
-
/**
|
|
8896
|
-
* User not authenticated
|
|
9773
|
+
* List of platforms with binding and account counts
|
|
8897
9774
|
*/
|
|
8898
|
-
|
|
9775
|
+
200: unknown;
|
|
8899
9776
|
};
|
|
8900
9777
|
};
|
|
8901
|
-
};
|
|
8902
|
-
'/api/v1/{region}/bean/prices': {
|
|
8903
9778
|
post: {
|
|
8904
|
-
req:
|
|
9779
|
+
req: PlatformControllerCreateData;
|
|
8905
9780
|
res: {
|
|
8906
9781
|
/**
|
|
8907
|
-
*
|
|
8908
|
-
*/
|
|
8909
|
-
201: PriceResponseDto;
|
|
8910
|
-
/**
|
|
8911
|
-
* Currency or quoteCurrency commodity not found
|
|
9782
|
+
* Platform created successfully
|
|
8912
9783
|
*/
|
|
8913
|
-
|
|
9784
|
+
201: unknown;
|
|
8914
9785
|
/**
|
|
8915
|
-
*
|
|
9786
|
+
* Platform already exists
|
|
8916
9787
|
*/
|
|
8917
9788
|
409: unknown;
|
|
8918
9789
|
};
|
|
8919
9790
|
};
|
|
9791
|
+
};
|
|
9792
|
+
'/api/v1/bean/platforms/list': {
|
|
8920
9793
|
get: {
|
|
8921
|
-
req: PriceControllerFindAllData;
|
|
8922
9794
|
res: {
|
|
8923
9795
|
/**
|
|
8924
|
-
*
|
|
9796
|
+
* List of platforms with user binding status
|
|
8925
9797
|
*/
|
|
8926
|
-
200:
|
|
9798
|
+
200: Array<PlatformListItemDto>;
|
|
8927
9799
|
};
|
|
8928
9800
|
};
|
|
8929
9801
|
};
|
|
8930
|
-
'/api/v1/
|
|
9802
|
+
'/api/v1/bean/platforms/match': {
|
|
8931
9803
|
get: {
|
|
8932
|
-
req:
|
|
9804
|
+
req: PlatformControllerMatchPlatformsData;
|
|
8933
9805
|
res: {
|
|
8934
9806
|
/**
|
|
8935
|
-
*
|
|
8936
|
-
*/
|
|
8937
|
-
200: PriceResponseDto;
|
|
8938
|
-
/**
|
|
8939
|
-
* Price not found
|
|
9807
|
+
* Matching platforms with overall match type and truncation flag
|
|
8940
9808
|
*/
|
|
8941
|
-
|
|
9809
|
+
200: PlatformMatchResponseDto;
|
|
8942
9810
|
};
|
|
8943
9811
|
};
|
|
9812
|
+
};
|
|
9813
|
+
'/api/v1/bean/platforms/{id}': {
|
|
8944
9814
|
put: {
|
|
8945
|
-
req:
|
|
9815
|
+
req: PlatformControllerUpdateData;
|
|
8946
9816
|
res: {
|
|
8947
9817
|
/**
|
|
8948
|
-
*
|
|
9818
|
+
* Platform updated successfully
|
|
8949
9819
|
*/
|
|
8950
|
-
200:
|
|
9820
|
+
200: unknown;
|
|
8951
9821
|
/**
|
|
8952
|
-
*
|
|
9822
|
+
* Platform not found
|
|
8953
9823
|
*/
|
|
8954
9824
|
404: unknown;
|
|
8955
|
-
/**
|
|
8956
|
-
* Updated price conflicts with existing price
|
|
8957
|
-
*/
|
|
8958
|
-
409: unknown;
|
|
8959
9825
|
};
|
|
8960
9826
|
};
|
|
8961
9827
|
delete: {
|
|
8962
|
-
req:
|
|
9828
|
+
req: PlatformControllerDeleteData;
|
|
8963
9829
|
res: {
|
|
8964
9830
|
/**
|
|
8965
|
-
*
|
|
9831
|
+
* Platform deleted successfully
|
|
8966
9832
|
*/
|
|
8967
9833
|
204: void;
|
|
8968
9834
|
/**
|
|
8969
|
-
*
|
|
9835
|
+
* Platform not found
|
|
8970
9836
|
*/
|
|
8971
9837
|
404: unknown;
|
|
8972
9838
|
};
|
|
8973
9839
|
};
|
|
8974
9840
|
};
|
|
8975
|
-
'/api/v1/{region}/
|
|
8976
|
-
|
|
8977
|
-
req:
|
|
9841
|
+
'/api/v1/{region}/dashboard/net-worth': {
|
|
9842
|
+
get: {
|
|
9843
|
+
req: DashboardControllerGetNetWorthData;
|
|
8978
9844
|
res: {
|
|
8979
9845
|
/**
|
|
8980
|
-
*
|
|
9846
|
+
* Net worth retrieved successfully
|
|
8981
9847
|
*/
|
|
8982
|
-
|
|
9848
|
+
200: NetWorthResponseDto;
|
|
9849
|
+
/**
|
|
9850
|
+
* User not authenticated
|
|
9851
|
+
*/
|
|
9852
|
+
401: unknown;
|
|
8983
9853
|
};
|
|
8984
9854
|
};
|
|
8985
9855
|
};
|
|
8986
|
-
'/api/v1/{region}/
|
|
9856
|
+
'/api/v1/{region}/dashboard/accounts': {
|
|
8987
9857
|
get: {
|
|
8988
|
-
req:
|
|
9858
|
+
req: DashboardControllerGetAccountsData;
|
|
8989
9859
|
res: {
|
|
8990
9860
|
/**
|
|
8991
|
-
*
|
|
9861
|
+
* Accounts retrieved successfully. Response type depends on groupBy parameter.
|
|
8992
9862
|
*/
|
|
8993
|
-
200:
|
|
9863
|
+
200:
|
|
9864
|
+
| AccountsResponseDto
|
|
9865
|
+
| AssetClassAccountsResponseDto
|
|
9866
|
+
| HoldingAssetClassCrossAccountResponseDto;
|
|
8994
9867
|
/**
|
|
8995
9868
|
* User not authenticated
|
|
8996
9869
|
*/
|
|
@@ -8998,14 +9871,18 @@ export type $OpenApiTs = {
|
|
|
8998
9871
|
};
|
|
8999
9872
|
};
|
|
9000
9873
|
};
|
|
9001
|
-
'/api/v1/{region}/
|
|
9874
|
+
'/api/v1/{region}/dashboard/cash-flow': {
|
|
9002
9875
|
get: {
|
|
9003
|
-
req:
|
|
9876
|
+
req: DashboardControllerGetCashFlowData;
|
|
9004
9877
|
res: {
|
|
9005
9878
|
/**
|
|
9006
|
-
* Cash
|
|
9879
|
+
* Cash flow retrieved successfully
|
|
9007
9880
|
*/
|
|
9008
|
-
200:
|
|
9881
|
+
200: CashFlowResponseDto;
|
|
9882
|
+
/**
|
|
9883
|
+
* Invalid period format
|
|
9884
|
+
*/
|
|
9885
|
+
400: unknown;
|
|
9009
9886
|
/**
|
|
9010
9887
|
* User not authenticated
|
|
9011
9888
|
*/
|
|
@@ -9013,16 +9890,16 @@ export type $OpenApiTs = {
|
|
|
9013
9890
|
};
|
|
9014
9891
|
};
|
|
9015
9892
|
};
|
|
9016
|
-
'/api/v1/{region}/
|
|
9017
|
-
|
|
9018
|
-
req:
|
|
9893
|
+
'/api/v1/{region}/dashboard/expenses': {
|
|
9894
|
+
get: {
|
|
9895
|
+
req: DashboardControllerGetExpensesData;
|
|
9019
9896
|
res: {
|
|
9020
9897
|
/**
|
|
9021
|
-
*
|
|
9898
|
+
* Expenses retrieved successfully
|
|
9022
9899
|
*/
|
|
9023
|
-
200:
|
|
9900
|
+
200: ExpensesByCategoryResponseDto;
|
|
9024
9901
|
/**
|
|
9025
|
-
* Invalid
|
|
9902
|
+
* Invalid groupBy or period
|
|
9026
9903
|
*/
|
|
9027
9904
|
400: unknown;
|
|
9028
9905
|
/**
|
|
@@ -9032,26 +9909,22 @@ export type $OpenApiTs = {
|
|
|
9032
9909
|
};
|
|
9033
9910
|
};
|
|
9034
9911
|
};
|
|
9035
|
-
'/api/v1/{region}/
|
|
9036
|
-
|
|
9037
|
-
req:
|
|
9912
|
+
'/api/v1/{region}/investment/holdings/pnl': {
|
|
9913
|
+
get: {
|
|
9914
|
+
req: HoldingPnlControllerGetHoldingPnlData;
|
|
9038
9915
|
res: {
|
|
9039
9916
|
/**
|
|
9040
|
-
*
|
|
9917
|
+
* Holding P&L retrieved successfully
|
|
9041
9918
|
*/
|
|
9042
|
-
200:
|
|
9919
|
+
200: HoldingPnlResponseDto;
|
|
9043
9920
|
/**
|
|
9044
|
-
* Invalid date format or
|
|
9921
|
+
* Invalid asOf format/value/future date, invalid accountId format, or unsupported method
|
|
9045
9922
|
*/
|
|
9046
9923
|
400: unknown;
|
|
9047
9924
|
/**
|
|
9048
9925
|
* User not authenticated
|
|
9049
9926
|
*/
|
|
9050
9927
|
401: unknown;
|
|
9051
|
-
/**
|
|
9052
|
-
* Backfill already in progress for this user
|
|
9053
|
-
*/
|
|
9054
|
-
409: unknown;
|
|
9055
9928
|
};
|
|
9056
9929
|
};
|
|
9057
9930
|
};
|
|
@@ -9076,7 +9949,7 @@ export type $OpenApiTs = {
|
|
|
9076
9949
|
/**
|
|
9077
9950
|
* Login successful
|
|
9078
9951
|
*/
|
|
9079
|
-
200:
|
|
9952
|
+
200: AnonymousLoginResponseDto;
|
|
9080
9953
|
/**
|
|
9081
9954
|
* Invalid access token
|
|
9082
9955
|
*/
|
|
@@ -9223,4 +10096,30 @@ export type $OpenApiTs = {
|
|
|
9223
10096
|
};
|
|
9224
10097
|
};
|
|
9225
10098
|
};
|
|
10099
|
+
'/api/v1/market/symbols/search': {
|
|
10100
|
+
get: {
|
|
10101
|
+
req: SymbolControllerSearchData;
|
|
10102
|
+
res: {
|
|
10103
|
+
/**
|
|
10104
|
+
* Ranked search results
|
|
10105
|
+
*/
|
|
10106
|
+
200: Array<SymbolSearchResultDto>;
|
|
10107
|
+
};
|
|
10108
|
+
};
|
|
10109
|
+
};
|
|
10110
|
+
'/api/v1/market/symbols/{symbol}/quote': {
|
|
10111
|
+
get: {
|
|
10112
|
+
req: SymbolControllerGetQuoteData;
|
|
10113
|
+
res: {
|
|
10114
|
+
/**
|
|
10115
|
+
* Symbol quote
|
|
10116
|
+
*/
|
|
10117
|
+
200: SymbolQuoteDto;
|
|
10118
|
+
/**
|
|
10119
|
+
* Symbol not found in the openbb catalog
|
|
10120
|
+
*/
|
|
10121
|
+
404: unknown;
|
|
10122
|
+
};
|
|
10123
|
+
};
|
|
10124
|
+
};
|
|
9226
10125
|
};
|