@firela/api-types 0.0.0-canary.9d0af796 → 0.0.0-canary.a026f79e
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 +4660 -3344
- package/dist/index.d.ts +4660 -3344
- package/dist/index.js +36 -6
- package/dist/index.mjs +36 -6
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +3181 -1414
- package/src/generated/services.gen.ts +1258 -785
- package/src/generated/types.gen.ts +25837 -3802
|
@@ -17,6 +17,8 @@ import type {
|
|
|
17
17
|
AccountControllerCloseResponse,
|
|
18
18
|
AccountControllerReopenData,
|
|
19
19
|
AccountControllerReopenResponse,
|
|
20
|
+
AccountControllerAddOpeningBalanceData,
|
|
21
|
+
AccountControllerAddOpeningBalanceResponse,
|
|
20
22
|
AccountStandardsControllerGetTemplatesData,
|
|
21
23
|
AccountStandardsControllerGetTemplatesResponse,
|
|
22
24
|
AccountStandardsControllerGetTemplateMetadataData,
|
|
@@ -97,6 +99,48 @@ import type {
|
|
|
97
99
|
CommodityControllerGetOrCreateResponse,
|
|
98
100
|
CommodityControllerBulkCreateData,
|
|
99
101
|
CommodityControllerBulkCreateResponse,
|
|
102
|
+
ReportingControllerGetPortfolioTrendsData,
|
|
103
|
+
ReportingControllerGetPortfolioTrendsResponse,
|
|
104
|
+
ReportingControllerGetCashFlowTrendsData,
|
|
105
|
+
ReportingControllerGetCashFlowTrendsResponse,
|
|
106
|
+
ReportingControllerGenerateSnapshotData,
|
|
107
|
+
ReportingControllerGenerateSnapshotResponse,
|
|
108
|
+
ReportingControllerBackfillSnapshotsData,
|
|
109
|
+
ReportingControllerBackfillSnapshotsResponse,
|
|
110
|
+
PriceControllerCreateData,
|
|
111
|
+
PriceControllerCreateResponse,
|
|
112
|
+
PriceControllerFindAllData,
|
|
113
|
+
PriceControllerFindAllResponse,
|
|
114
|
+
PriceControllerFindOneData,
|
|
115
|
+
PriceControllerFindOneResponse,
|
|
116
|
+
PriceControllerUpdateData,
|
|
117
|
+
PriceControllerUpdateResponse,
|
|
118
|
+
PriceControllerDeleteData,
|
|
119
|
+
PriceControllerDeleteResponse,
|
|
120
|
+
PriceControllerBulkCreateData,
|
|
121
|
+
PriceControllerBulkCreateResponse,
|
|
122
|
+
UserControllerDeleteOwnUserData,
|
|
123
|
+
UserControllerDeleteOwnUserResponse,
|
|
124
|
+
UserControllerGetUserData,
|
|
125
|
+
UserControllerGetUserResponse,
|
|
126
|
+
UserControllerSignupUserData,
|
|
127
|
+
UserControllerSignupUserResponse,
|
|
128
|
+
UserControllerDeleteUserData,
|
|
129
|
+
UserControllerDeleteUserResponse,
|
|
130
|
+
UserControllerGetUserInfoData,
|
|
131
|
+
UserControllerGetUserInfoResponse,
|
|
132
|
+
UserControllerUpdateUserSettingData,
|
|
133
|
+
UserControllerUpdateUserSettingResponse,
|
|
134
|
+
UserControllerGetAllUserSettingsByPageData,
|
|
135
|
+
UserControllerGetAllUserSettingsByPageResponse,
|
|
136
|
+
UserControllerGetAssetLiabilitySummaryResponse,
|
|
137
|
+
PropertyControllerGetAllResponse,
|
|
138
|
+
PropertyControllerGetByKeyData,
|
|
139
|
+
PropertyControllerGetByKeyResponse,
|
|
140
|
+
PropertyControllerUpdateData,
|
|
141
|
+
PropertyControllerUpdateResponse,
|
|
142
|
+
PropertyControllerDeleteData,
|
|
143
|
+
PropertyControllerDeleteResponse,
|
|
100
144
|
RecurringRuleControllerCreateData,
|
|
101
145
|
RecurringRuleControllerCreateResponse,
|
|
102
146
|
RecurringRuleControllerFindAllData,
|
|
@@ -149,28 +193,8 @@ import type {
|
|
|
149
193
|
TransactionRuleControllerDeleteResponse,
|
|
150
194
|
TransactionRuleControllerTestData,
|
|
151
195
|
TransactionRuleControllerTestResponse,
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
UserControllerGetUserData,
|
|
155
|
-
UserControllerGetUserResponse,
|
|
156
|
-
UserControllerSignupUserData,
|
|
157
|
-
UserControllerSignupUserResponse,
|
|
158
|
-
UserControllerDeleteUserData,
|
|
159
|
-
UserControllerDeleteUserResponse,
|
|
160
|
-
UserControllerGetUserInfoData,
|
|
161
|
-
UserControllerGetUserInfoResponse,
|
|
162
|
-
UserControllerUpdateUserSettingData,
|
|
163
|
-
UserControllerUpdateUserSettingResponse,
|
|
164
|
-
UserControllerGetAllUserSettingsByPageData,
|
|
165
|
-
UserControllerGetAllUserSettingsByPageResponse,
|
|
166
|
-
UserControllerGetAssetLiabilitySummaryResponse,
|
|
167
|
-
PropertyControllerGetAllResponse,
|
|
168
|
-
PropertyControllerGetByKeyData,
|
|
169
|
-
PropertyControllerGetByKeyResponse,
|
|
170
|
-
PropertyControllerUpdateData,
|
|
171
|
-
PropertyControllerUpdateResponse,
|
|
172
|
-
PropertyControllerDeleteData,
|
|
173
|
-
PropertyControllerDeleteResponse,
|
|
196
|
+
CategoryCatalogControllerListData,
|
|
197
|
+
CategoryCatalogControllerListResponse,
|
|
174
198
|
EventControllerCreateData,
|
|
175
199
|
EventControllerCreateResponse,
|
|
176
200
|
EventControllerFindAllData,
|
|
@@ -183,6 +207,16 @@ import type {
|
|
|
183
207
|
EventControllerDeleteResponse,
|
|
184
208
|
EventControllerGetSliceData,
|
|
185
209
|
EventControllerGetSliceResponse,
|
|
210
|
+
OnboardingControllerBootstrapData,
|
|
211
|
+
OnboardingControllerBootstrapResponse,
|
|
212
|
+
ReconciliationControllerComputeData,
|
|
213
|
+
ReconciliationControllerComputeResponse,
|
|
214
|
+
ReconciliationControllerAssertData,
|
|
215
|
+
ReconciliationControllerAssertResponse,
|
|
216
|
+
ReconciliationControllerPadData,
|
|
217
|
+
ReconciliationControllerPadResponse,
|
|
218
|
+
ReconciliationControllerHistoryData,
|
|
219
|
+
ReconciliationControllerHistoryResponse,
|
|
186
220
|
ExportControllerExportBeancountResponse,
|
|
187
221
|
FileImportControllerImportFileData,
|
|
188
222
|
FileImportControllerImportFileResponse,
|
|
@@ -196,22 +230,20 @@ import type {
|
|
|
196
230
|
ImporterConfigControllerUpdateConfigResponse,
|
|
197
231
|
ImporterConfigControllerResetConfigData,
|
|
198
232
|
ImporterConfigControllerResetConfigResponse,
|
|
199
|
-
PlatformControllerFindAllResponse,
|
|
200
|
-
PlatformControllerCreateData,
|
|
201
|
-
PlatformControllerCreateResponse,
|
|
202
|
-
PlatformControllerGetPlatformListResponse,
|
|
203
|
-
PlatformControllerMatchPlatformsData,
|
|
204
|
-
PlatformControllerMatchPlatformsResponse,
|
|
205
|
-
PlatformControllerUpdateData,
|
|
206
|
-
PlatformControllerUpdateResponse,
|
|
207
|
-
PlatformControllerDeleteData,
|
|
208
|
-
PlatformControllerDeleteResponse,
|
|
209
233
|
ProviderSyncControllerSyncData,
|
|
210
234
|
ProviderSyncControllerSyncResponse,
|
|
211
235
|
ProviderSyncControllerGetSupportedProvidersData,
|
|
212
236
|
ProviderSyncControllerGetSupportedProvidersResponse,
|
|
213
237
|
ProviderSyncControllerIsProviderSupportedData,
|
|
214
238
|
ProviderSyncControllerIsProviderSupportedResponse,
|
|
239
|
+
ExternalAccountLinkControllerCreateData,
|
|
240
|
+
ExternalAccountLinkControllerCreateResponse,
|
|
241
|
+
ExternalAccountLinkControllerFindAllData,
|
|
242
|
+
ExternalAccountLinkControllerFindAllResponse,
|
|
243
|
+
ExternalAccountLinkControllerFindOneData,
|
|
244
|
+
ExternalAccountLinkControllerFindOneResponse,
|
|
245
|
+
ExternalAccountLinkControllerRemoveData,
|
|
246
|
+
ExternalAccountLinkControllerRemoveResponse,
|
|
215
247
|
TelemetryControllerReportTelemetryData,
|
|
216
248
|
TelemetryControllerReportTelemetryResponse,
|
|
217
249
|
TelemetryControllerReportCoverageMissData,
|
|
@@ -224,37 +256,34 @@ import type {
|
|
|
224
256
|
NlpControllerClearSessionResponse,
|
|
225
257
|
NlpControllerGetSessionData,
|
|
226
258
|
NlpControllerGetSessionResponse,
|
|
259
|
+
PlatformControllerFindAllResponse,
|
|
260
|
+
PlatformControllerCreateData,
|
|
261
|
+
PlatformControllerCreateResponse,
|
|
262
|
+
PlatformControllerGetPlatformListData,
|
|
263
|
+
PlatformControllerGetPlatformListResponse,
|
|
264
|
+
PlatformControllerMatchPlatformsData,
|
|
265
|
+
PlatformControllerMatchPlatformsResponse,
|
|
266
|
+
PlatformControllerGetPlatformStandardsData,
|
|
267
|
+
PlatformControllerGetPlatformStandardsResponse,
|
|
268
|
+
PlatformControllerUpdateData,
|
|
269
|
+
PlatformControllerUpdateResponse,
|
|
270
|
+
PlatformControllerDeleteData,
|
|
271
|
+
PlatformControllerDeleteResponse,
|
|
227
272
|
DashboardControllerGetNetWorthData,
|
|
228
273
|
DashboardControllerGetNetWorthResponse,
|
|
229
274
|
DashboardControllerGetAccountsData,
|
|
230
275
|
DashboardControllerGetAccountsResponse,
|
|
231
276
|
DashboardControllerGetCashFlowData,
|
|
232
277
|
DashboardControllerGetCashFlowResponse,
|
|
278
|
+
DashboardControllerGetExpensesData,
|
|
279
|
+
DashboardControllerGetExpensesResponse,
|
|
233
280
|
HoldingPnlControllerGetHoldingPnlData,
|
|
234
281
|
HoldingPnlControllerGetHoldingPnlResponse,
|
|
235
|
-
PriceControllerCreateData,
|
|
236
|
-
PriceControllerCreateResponse,
|
|
237
|
-
PriceControllerFindAllData,
|
|
238
|
-
PriceControllerFindAllResponse,
|
|
239
|
-
PriceControllerFindOneData,
|
|
240
|
-
PriceControllerFindOneResponse,
|
|
241
|
-
PriceControllerUpdateData,
|
|
242
|
-
PriceControllerUpdateResponse,
|
|
243
|
-
PriceControllerDeleteData,
|
|
244
|
-
PriceControllerDeleteResponse,
|
|
245
|
-
PriceControllerBulkCreateData,
|
|
246
|
-
PriceControllerBulkCreateResponse,
|
|
247
|
-
ReportingControllerGetPortfolioTrendsData,
|
|
248
|
-
ReportingControllerGetPortfolioTrendsResponse,
|
|
249
|
-
ReportingControllerGetCashFlowTrendsData,
|
|
250
|
-
ReportingControllerGetCashFlowTrendsResponse,
|
|
251
|
-
ReportingControllerGenerateSnapshotData,
|
|
252
|
-
ReportingControllerGenerateSnapshotResponse,
|
|
253
|
-
ReportingControllerBackfillSnapshotsData,
|
|
254
|
-
ReportingControllerBackfillSnapshotsResponse,
|
|
255
282
|
ApiKeysControllerCreateApiKeyResponse,
|
|
256
283
|
AuthControllerAccessTokenLoginData,
|
|
257
284
|
AuthControllerAccessTokenLoginResponse,
|
|
285
|
+
ParserContributionControllerCreateData,
|
|
286
|
+
ParserContributionControllerCreateResponse,
|
|
258
287
|
CacheControllerFlushCacheResponse,
|
|
259
288
|
ExchangeRateControllerGetExchangeRateData,
|
|
260
289
|
ExchangeRateControllerGetExchangeRateResponse,
|
|
@@ -266,7 +295,11 @@ import type {
|
|
|
266
295
|
HealthControllerResetCircuitBreakerData,
|
|
267
296
|
HealthControllerResetCircuitBreakerResponse,
|
|
268
297
|
HealthControllerGetMetricsResponse,
|
|
269
|
-
InfoControllerGetInfoResponse
|
|
298
|
+
InfoControllerGetInfoResponse,
|
|
299
|
+
SymbolControllerSearchData,
|
|
300
|
+
SymbolControllerSearchResponse,
|
|
301
|
+
SymbolControllerGetQuoteData,
|
|
302
|
+
SymbolControllerGetQuoteResponse
|
|
270
303
|
} from './types.gen';
|
|
271
304
|
|
|
272
305
|
export class BeanAccountsService {
|
|
@@ -304,7 +337,7 @@ export class BeanAccountsService {
|
|
|
304
337
|
* @param data.type Filter by account type
|
|
305
338
|
* @param data.status Filter by status
|
|
306
339
|
* @param data.isCustom Filter by custom (user-created) accounts only
|
|
307
|
-
* @param data.search Search term
|
|
340
|
+
* @param data.search Search term matched against account path and user-set display name (case-insensitive)
|
|
308
341
|
* @param data.limit Maximum number of results
|
|
309
342
|
* @param data.offset Number of results to skip
|
|
310
343
|
* @returns AccountListResponseDto Accounts retrieved successfully
|
|
@@ -385,7 +418,7 @@ export class BeanAccountsService {
|
|
|
385
418
|
|
|
386
419
|
/**
|
|
387
420
|
* Delete account
|
|
388
|
-
* Deletes an account (only if no transactions)
|
|
421
|
+
* Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
|
|
389
422
|
* @param data The data for the request.
|
|
390
423
|
* @param data.id Account UUID
|
|
391
424
|
* @param data.region Region code for tenant context
|
|
@@ -404,7 +437,7 @@ export class BeanAccountsService {
|
|
|
404
437
|
},
|
|
405
438
|
errors: {
|
|
406
439
|
404: 'Account not found',
|
|
407
|
-
409: 'Account has transactions and cannot be deleted'
|
|
440
|
+
409: 'Account has active transactions and cannot be deleted'
|
|
408
441
|
}
|
|
409
442
|
});
|
|
410
443
|
}
|
|
@@ -466,16 +499,45 @@ export class BeanAccountsService {
|
|
|
466
499
|
}
|
|
467
500
|
});
|
|
468
501
|
}
|
|
502
|
+
|
|
503
|
+
/**
|
|
504
|
+
* Post an opening-balance transaction
|
|
505
|
+
* Posts a double-entry opening-balance transaction against Equity:Opening-Balances for an existing Assets/Liabilities account. At most one active opening balance per account.
|
|
506
|
+
* @param data The data for the request.
|
|
507
|
+
* @param data.id Account UUID
|
|
508
|
+
* @param data.region Region code for tenant context
|
|
509
|
+
* @param data.requestBody
|
|
510
|
+
* @returns OpeningBalanceResultDto Opening-balance transaction created
|
|
511
|
+
* @throws ApiError
|
|
512
|
+
*/
|
|
513
|
+
public static accountControllerAddOpeningBalance(
|
|
514
|
+
data: AccountControllerAddOpeningBalanceData
|
|
515
|
+
): CancelablePromise<AccountControllerAddOpeningBalanceResponse> {
|
|
516
|
+
return __request(OpenAPI, {
|
|
517
|
+
method: 'POST',
|
|
518
|
+
url: '/api/v1/{region}/bean/accounts/{id}/opening-balance',
|
|
519
|
+
path: {
|
|
520
|
+
id: data.id,
|
|
521
|
+
region: data.region
|
|
522
|
+
},
|
|
523
|
+
body: data.requestBody,
|
|
524
|
+
mediaType: 'application/json',
|
|
525
|
+
errors: {
|
|
526
|
+
404: 'Account not found',
|
|
527
|
+
409: 'An opening balance already exists for this account'
|
|
528
|
+
}
|
|
529
|
+
});
|
|
530
|
+
}
|
|
469
531
|
}
|
|
470
532
|
|
|
471
533
|
export class BeanAccountStandardsService {
|
|
472
534
|
/**
|
|
473
535
|
* Get account templates
|
|
474
|
-
* Returns predefined account templates for a region. Supports filtering by account type and search term.
|
|
536
|
+
* Returns predefined account templates for a region. Supports filtering by account type and search term. Not-yet-open region codes return the universal-only catalog (#759).
|
|
475
537
|
* @param data The data for the request.
|
|
476
|
-
* @param data.region Region code (
|
|
538
|
+
* @param data.region Region code (any ISO alpha-2; not-yet-open codes return the universal-only catalog)
|
|
477
539
|
* @param data.type Filter by account type
|
|
478
|
-
* @param data.search Search term for path or
|
|
540
|
+
* @param data.search Search term for path, description, aliases, or localized display name
|
|
479
541
|
* @returns AccountStandardListResponseDto Account templates retrieved successfully
|
|
480
542
|
* @throws ApiError
|
|
481
543
|
*/
|
|
@@ -497,9 +559,9 @@ export class BeanAccountStandardsService {
|
|
|
497
559
|
|
|
498
560
|
/**
|
|
499
561
|
* Get template metadata for an account path
|
|
500
|
-
* Returns
|
|
562
|
+
* Returns root type for a template path.
|
|
501
563
|
* @param data The data for the request.
|
|
502
|
-
* @param data.region Region code for tenant context
|
|
564
|
+
* @param data.region Region code for tenant context. Not-yet-open codes degrade to the universal-only catalog (#759)
|
|
503
565
|
* @param data.path Account path to check
|
|
504
566
|
* @returns TemplateMetadataResponseDto Template metadata retrieved successfully
|
|
505
567
|
* @throws ApiError
|
|
@@ -521,9 +583,9 @@ export class BeanAccountStandardsService {
|
|
|
521
583
|
|
|
522
584
|
/**
|
|
523
585
|
* Get available regions with hierarchy
|
|
524
|
-
* Returns
|
|
586
|
+
* Returns the full region catalog (every ISO 3166-1 entry) with an 'open' flag and inheritance metadata (#759)
|
|
525
587
|
* @param data The data for the request.
|
|
526
|
-
* @param data.region Region code for tenant context
|
|
588
|
+
* @param data.region Region code for tenant context. Not-yet-open codes degrade to the universal-only catalog (#759)
|
|
527
589
|
* @returns RegionsMetadataResponseDto Regions metadata retrieved successfully
|
|
528
590
|
* @throws ApiError
|
|
529
591
|
*/
|
|
@@ -580,9 +642,11 @@ export class BeanTransactionsService {
|
|
|
580
642
|
* @param data.offset Number of items to skip (default: 0)
|
|
581
643
|
* @param data.dateFrom Filter by start date (inclusive), format: YYYY-MM-DD
|
|
582
644
|
* @param data.dateTo Filter by end date (inclusive), format: YYYY-MM-DD
|
|
583
|
-
* @param data.status Filter by transaction status
|
|
645
|
+
* @param data.status Filter by transaction status: single value, comma-separated multi-value (e.g. VOIDED,SUPERSEDED), or ALL to include audit rows. Defaults to ACTIVE-only (ADR-0128; previously unfiltered — breaking change).
|
|
584
646
|
* @param data.search Search in narration and payee fields (max 200 chars)
|
|
585
647
|
* @param data.accountId Filter by account ID (transactions with postings to this account)
|
|
648
|
+
* @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an account whose derived Group segment equals this value. Must be accompanied by flow (ADR-0126).
|
|
649
|
+
* @param data.flow Required when category is present (400 otherwise) and vice versa (ADR-0126). Restricts the category account set to the flow root (income → Income:, expense → Expenses:) and drives the per-leg sign normalization of row viewpointAmount and the summary. OpenAPI cannot express conditional requiredness — the pairing is enforced at runtime.
|
|
586
650
|
* @returns TransactionListResponseDto Transaction list
|
|
587
651
|
* @throws ApiError
|
|
588
652
|
*/
|
|
@@ -602,7 +666,9 @@ export class BeanTransactionsService {
|
|
|
602
666
|
dateTo: data.dateTo,
|
|
603
667
|
status: data.status,
|
|
604
668
|
search: data.search,
|
|
605
|
-
accountId: data.accountId
|
|
669
|
+
accountId: data.accountId,
|
|
670
|
+
category: data.category,
|
|
671
|
+
flow: data.flow
|
|
606
672
|
},
|
|
607
673
|
errors: {
|
|
608
674
|
400: 'Validation failed',
|
|
@@ -790,7 +856,7 @@ export class BeanBalancesService {
|
|
|
790
856
|
* Query account balance
|
|
791
857
|
* Calculate account balance at a specific date for a single currency
|
|
792
858
|
* @param data The data for the request.
|
|
793
|
-
* @param data.account Account name (e.g., "Assets:
|
|
859
|
+
* @param data.account Account name (e.g., "Assets:Checking")
|
|
794
860
|
* @param data.region Region code for tenant context
|
|
795
861
|
* @param data.date Date to calculate balance at (ISO 8601 format)
|
|
796
862
|
* @param data.currency Currency to query (e.g., "USD", "CNY")
|
|
@@ -1315,7 +1381,7 @@ export class AdminPayeeProfilesService {
|
|
|
1315
1381
|
* Removes verification status by setting verifiedAt to null.
|
|
1316
1382
|
* @param data The data for the request.
|
|
1317
1383
|
* @param data.id Payee profile ID (UUID)
|
|
1318
|
-
* @returns
|
|
1384
|
+
* @returns void Payee profile unverified successfully
|
|
1319
1385
|
* @throws ApiError
|
|
1320
1386
|
*/
|
|
1321
1387
|
public static payeeProfileAdminControllerUnverify(
|
|
@@ -1511,96 +1577,675 @@ export class BeanCommoditiesService {
|
|
|
1511
1577
|
}
|
|
1512
1578
|
}
|
|
1513
1579
|
|
|
1514
|
-
export class
|
|
1580
|
+
export class ReportingService {
|
|
1515
1581
|
/**
|
|
1516
|
-
*
|
|
1517
|
-
*
|
|
1582
|
+
* Get portfolio value trends
|
|
1583
|
+
*
|
|
1584
|
+
* Returns time series data of portfolio net worth.
|
|
1585
|
+
*
|
|
1586
|
+
* **Multi-currency Support:**
|
|
1587
|
+
* - `series[].byCurrency` - Currency breakdown for each data point
|
|
1588
|
+
* - `byCurrency` - Separate time series grouped by currency
|
|
1589
|
+
* - `warnings` - Exchange rate warnings if conversion failed
|
|
1590
|
+
*
|
|
1591
|
+
* **Parameters:**
|
|
1592
|
+
* - `period`: Time period (1m, 3m, 6m, 1y)
|
|
1593
|
+
* - `granularity`: Data granularity (day, week, month)
|
|
1594
|
+
*
|
|
1518
1595
|
* @param data The data for the request.
|
|
1519
1596
|
* @param data.region Region code for tenant context
|
|
1520
|
-
* @param data.
|
|
1521
|
-
* @
|
|
1597
|
+
* @param data.period Time period
|
|
1598
|
+
* @param data.granularity Data granularity
|
|
1599
|
+
* @returns PortfolioTrendsResponseDto Trends retrieved successfully
|
|
1522
1600
|
* @throws ApiError
|
|
1523
1601
|
*/
|
|
1524
|
-
public static
|
|
1525
|
-
data:
|
|
1526
|
-
): CancelablePromise<
|
|
1602
|
+
public static reportingControllerGetPortfolioTrends(
|
|
1603
|
+
data: ReportingControllerGetPortfolioTrendsData
|
|
1604
|
+
): CancelablePromise<ReportingControllerGetPortfolioTrendsResponse> {
|
|
1527
1605
|
return __request(OpenAPI, {
|
|
1528
|
-
method: '
|
|
1529
|
-
url: '/api/v1/{region}/
|
|
1606
|
+
method: 'GET',
|
|
1607
|
+
url: '/api/v1/{region}/reporting/portfolio/trends',
|
|
1530
1608
|
path: {
|
|
1531
1609
|
region: data.region
|
|
1532
1610
|
},
|
|
1533
|
-
|
|
1534
|
-
|
|
1611
|
+
query: {
|
|
1612
|
+
period: data.period,
|
|
1613
|
+
granularity: data.granularity
|
|
1614
|
+
},
|
|
1535
1615
|
errors: {
|
|
1536
|
-
|
|
1537
|
-
409: 'Rule with same name already exists'
|
|
1616
|
+
401: 'User not authenticated'
|
|
1538
1617
|
}
|
|
1539
1618
|
});
|
|
1540
1619
|
}
|
|
1541
1620
|
|
|
1542
1621
|
/**
|
|
1543
|
-
*
|
|
1544
|
-
*
|
|
1622
|
+
* Get cash-flow trends
|
|
1623
|
+
*
|
|
1624
|
+
* Monthly income / expense / netSavings over a fixed N-month window
|
|
1625
|
+
* (current month + N−1 prior). Missing months are zero-filled (flow metric).
|
|
1626
|
+
*
|
|
1627
|
+
* **Parameters:**
|
|
1628
|
+
* - `period`: 1m | 3m | 6m | 1y (default 6m)
|
|
1629
|
+
* - `granularity`: accepted for API symmetry; v1 returns month buckets
|
|
1630
|
+
*
|
|
1545
1631
|
* @param data The data for the request.
|
|
1546
1632
|
* @param data.region Region code for tenant context
|
|
1547
|
-
* @param data.
|
|
1548
|
-
* @param data.
|
|
1549
|
-
* @
|
|
1550
|
-
* @returns RecurringRuleResponseDto Rules retrieved successfully
|
|
1633
|
+
* @param data.period Time period
|
|
1634
|
+
* @param data.granularity Data granularity (accepted for API symmetry; v1 returns month buckets)
|
|
1635
|
+
* @returns CashFlowTrendsResponseDto Cash-flow trends retrieved successfully
|
|
1551
1636
|
* @throws ApiError
|
|
1552
1637
|
*/
|
|
1553
|
-
public static
|
|
1554
|
-
data:
|
|
1555
|
-
): CancelablePromise<
|
|
1638
|
+
public static reportingControllerGetCashFlowTrends(
|
|
1639
|
+
data: ReportingControllerGetCashFlowTrendsData
|
|
1640
|
+
): CancelablePromise<ReportingControllerGetCashFlowTrendsResponse> {
|
|
1556
1641
|
return __request(OpenAPI, {
|
|
1557
1642
|
method: 'GET',
|
|
1558
|
-
url: '/api/v1/{region}/
|
|
1643
|
+
url: '/api/v1/{region}/reporting/cash-flow/trends',
|
|
1559
1644
|
path: {
|
|
1560
1645
|
region: data.region
|
|
1561
1646
|
},
|
|
1562
1647
|
query: {
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1648
|
+
period: data.period,
|
|
1649
|
+
granularity: data.granularity
|
|
1650
|
+
},
|
|
1651
|
+
errors: {
|
|
1652
|
+
401: 'User not authenticated'
|
|
1566
1653
|
}
|
|
1567
1654
|
});
|
|
1568
1655
|
}
|
|
1569
1656
|
|
|
1570
1657
|
/**
|
|
1571
|
-
*
|
|
1572
|
-
*
|
|
1658
|
+
* Generate portfolio snapshot
|
|
1659
|
+
*
|
|
1660
|
+
* Manually generate a portfolio snapshot for a specific date.
|
|
1661
|
+
*
|
|
1662
|
+
* **Multi-currency Support:**
|
|
1663
|
+
* - Fetches balances grouped by currency
|
|
1664
|
+
* - Uses user's baseCurrency setting for conversion
|
|
1665
|
+
* - Stores exchange rates and warnings
|
|
1666
|
+
*
|
|
1667
|
+
* **Use Cases:**
|
|
1668
|
+
* - Testing snapshot generation
|
|
1669
|
+
* - Force regeneration after data correction
|
|
1670
|
+
* - Initial setup for new users
|
|
1671
|
+
*
|
|
1573
1672
|
* @param data The data for the request.
|
|
1574
|
-
* @param data.transactionId Source transaction ID
|
|
1575
1673
|
* @param data.region Region code for tenant context
|
|
1576
|
-
* @param data.requestBody
|
|
1577
|
-
* @returns
|
|
1674
|
+
* @param data.requestBody Optional date (defaults to today)
|
|
1675
|
+
* @returns GenerateSnapshotResponse Snapshot generated successfully
|
|
1578
1676
|
* @throws ApiError
|
|
1579
1677
|
*/
|
|
1580
|
-
public static
|
|
1581
|
-
data:
|
|
1582
|
-
): CancelablePromise<
|
|
1678
|
+
public static reportingControllerGenerateSnapshot(
|
|
1679
|
+
data: ReportingControllerGenerateSnapshotData
|
|
1680
|
+
): CancelablePromise<ReportingControllerGenerateSnapshotResponse> {
|
|
1583
1681
|
return __request(OpenAPI, {
|
|
1584
1682
|
method: 'POST',
|
|
1585
|
-
url: '/api/v1/{region}/
|
|
1683
|
+
url: '/api/v1/{region}/reporting/snapshots/generate',
|
|
1586
1684
|
path: {
|
|
1587
|
-
transactionId: data.transactionId,
|
|
1588
1685
|
region: data.region
|
|
1589
1686
|
},
|
|
1590
1687
|
body: data.requestBody,
|
|
1591
1688
|
mediaType: 'application/json',
|
|
1592
1689
|
errors: {
|
|
1593
|
-
|
|
1594
|
-
|
|
1690
|
+
400: 'Invalid date format',
|
|
1691
|
+
401: 'User not authenticated'
|
|
1595
1692
|
}
|
|
1596
1693
|
});
|
|
1597
1694
|
}
|
|
1598
1695
|
|
|
1599
1696
|
/**
|
|
1600
|
-
*
|
|
1601
|
-
*
|
|
1697
|
+
* Backfill portfolio snapshots
|
|
1698
|
+
*
|
|
1699
|
+
* Generate snapshots for a date range (historical data backfill).
|
|
1700
|
+
*
|
|
1701
|
+
* **Multi-currency Support:**
|
|
1702
|
+
* - Each snapshot includes multi-currency data
|
|
1703
|
+
* - Uses exchange rates available at generation time
|
|
1704
|
+
* - Warnings stored for missing exchange rates
|
|
1705
|
+
*
|
|
1706
|
+
* **Best Practices:**
|
|
1707
|
+
* - Use for initial setup after account configuration
|
|
1708
|
+
* - Run during low-traffic periods for large date ranges
|
|
1709
|
+
* - Existing snapshots are skipped (not regenerated)
|
|
1710
|
+
*
|
|
1602
1711
|
* @param data The data for the request.
|
|
1603
|
-
* @param data.
|
|
1712
|
+
* @param data.region Region code for tenant context
|
|
1713
|
+
* @param data.requestBody
|
|
1714
|
+
* @returns BackfillSnapshotsResponse Backfill completed successfully
|
|
1715
|
+
* @throws ApiError
|
|
1716
|
+
*/
|
|
1717
|
+
public static reportingControllerBackfillSnapshots(
|
|
1718
|
+
data: ReportingControllerBackfillSnapshotsData
|
|
1719
|
+
): CancelablePromise<ReportingControllerBackfillSnapshotsResponse> {
|
|
1720
|
+
return __request(OpenAPI, {
|
|
1721
|
+
method: 'POST',
|
|
1722
|
+
url: '/api/v1/{region}/reporting/snapshots/backfill',
|
|
1723
|
+
path: {
|
|
1724
|
+
region: data.region
|
|
1725
|
+
},
|
|
1726
|
+
body: data.requestBody,
|
|
1727
|
+
mediaType: 'application/json',
|
|
1728
|
+
errors: {
|
|
1729
|
+
400: 'Invalid date format or range',
|
|
1730
|
+
401: 'User not authenticated',
|
|
1731
|
+
409: 'Backfill already in progress for this user'
|
|
1732
|
+
}
|
|
1733
|
+
});
|
|
1734
|
+
}
|
|
1735
|
+
}
|
|
1736
|
+
|
|
1737
|
+
export class BeanPricesService {
|
|
1738
|
+
/**
|
|
1739
|
+
* Create a new price
|
|
1740
|
+
* Creates a new price entry for the authenticated user
|
|
1741
|
+
* @param data The data for the request.
|
|
1742
|
+
* @param data.region Region code for tenant context
|
|
1743
|
+
* @param data.requestBody
|
|
1744
|
+
* @returns PriceResponseDto Price created successfully
|
|
1745
|
+
* @throws ApiError
|
|
1746
|
+
*/
|
|
1747
|
+
public static priceControllerCreate(
|
|
1748
|
+
data: PriceControllerCreateData
|
|
1749
|
+
): CancelablePromise<PriceControllerCreateResponse> {
|
|
1750
|
+
return __request(OpenAPI, {
|
|
1751
|
+
method: 'POST',
|
|
1752
|
+
url: '/api/v1/{region}/bean/prices',
|
|
1753
|
+
path: {
|
|
1754
|
+
region: data.region
|
|
1755
|
+
},
|
|
1756
|
+
body: data.requestBody,
|
|
1757
|
+
mediaType: 'application/json',
|
|
1758
|
+
errors: {
|
|
1759
|
+
404: 'Currency or quoteCurrency commodity not found',
|
|
1760
|
+
409: 'Price already exists for this currency pair and date'
|
|
1761
|
+
}
|
|
1762
|
+
});
|
|
1763
|
+
}
|
|
1764
|
+
|
|
1765
|
+
/**
|
|
1766
|
+
* List user prices
|
|
1767
|
+
* Returns all price entries for the authenticated user with optional filtering
|
|
1768
|
+
* @param data The data for the request.
|
|
1769
|
+
* @param data.region Region code for tenant context
|
|
1770
|
+
* @param data.currency Filter by currency (e.g., BTC, AAPL, USD)
|
|
1771
|
+
* @param data.quoteCurrency Filter by quote currency (pricing currency, e.g., USD, CNY)
|
|
1772
|
+
* @param data.dateFrom Filter prices from this date (ISO 8601 format)
|
|
1773
|
+
* @param data.dateTo Filter prices to this date (ISO 8601 format)
|
|
1774
|
+
* @param data.search Search term for currency or quoteCurrency (case-insensitive partial match)
|
|
1775
|
+
* @param data.page Page number for pagination (default: 1)
|
|
1776
|
+
* @param data.limit Number of items per page (default: 20, max: 100)
|
|
1777
|
+
* @returns PriceListResponseDto Prices retrieved successfully
|
|
1778
|
+
* @throws ApiError
|
|
1779
|
+
*/
|
|
1780
|
+
public static priceControllerFindAll(
|
|
1781
|
+
data: PriceControllerFindAllData
|
|
1782
|
+
): CancelablePromise<PriceControllerFindAllResponse> {
|
|
1783
|
+
return __request(OpenAPI, {
|
|
1784
|
+
method: 'GET',
|
|
1785
|
+
url: '/api/v1/{region}/bean/prices',
|
|
1786
|
+
path: {
|
|
1787
|
+
region: data.region
|
|
1788
|
+
},
|
|
1789
|
+
query: {
|
|
1790
|
+
currency: data.currency,
|
|
1791
|
+
quoteCurrency: data.quoteCurrency,
|
|
1792
|
+
dateFrom: data.dateFrom,
|
|
1793
|
+
dateTo: data.dateTo,
|
|
1794
|
+
search: data.search,
|
|
1795
|
+
page: data.page,
|
|
1796
|
+
limit: data.limit
|
|
1797
|
+
}
|
|
1798
|
+
});
|
|
1799
|
+
}
|
|
1800
|
+
|
|
1801
|
+
/**
|
|
1802
|
+
* Get price by ID
|
|
1803
|
+
* Returns a single price entry by its ID
|
|
1804
|
+
* @param data The data for the request.
|
|
1805
|
+
* @param data.id Price ID
|
|
1806
|
+
* @param data.region Region code for tenant context
|
|
1807
|
+
* @returns PriceResponseDto Price retrieved successfully
|
|
1808
|
+
* @throws ApiError
|
|
1809
|
+
*/
|
|
1810
|
+
public static priceControllerFindOne(
|
|
1811
|
+
data: PriceControllerFindOneData
|
|
1812
|
+
): CancelablePromise<PriceControllerFindOneResponse> {
|
|
1813
|
+
return __request(OpenAPI, {
|
|
1814
|
+
method: 'GET',
|
|
1815
|
+
url: '/api/v1/{region}/bean/prices/{id}',
|
|
1816
|
+
path: {
|
|
1817
|
+
id: data.id,
|
|
1818
|
+
region: data.region
|
|
1819
|
+
},
|
|
1820
|
+
errors: {
|
|
1821
|
+
404: 'Price not found'
|
|
1822
|
+
}
|
|
1823
|
+
});
|
|
1824
|
+
}
|
|
1825
|
+
|
|
1826
|
+
/**
|
|
1827
|
+
* Update a price
|
|
1828
|
+
* Updates an existing price entry
|
|
1829
|
+
* @param data The data for the request.
|
|
1830
|
+
* @param data.id Price ID
|
|
1831
|
+
* @param data.region Region code for tenant context
|
|
1832
|
+
* @param data.requestBody
|
|
1833
|
+
* @returns PriceResponseDto Price updated successfully
|
|
1834
|
+
* @throws ApiError
|
|
1835
|
+
*/
|
|
1836
|
+
public static priceControllerUpdate(
|
|
1837
|
+
data: PriceControllerUpdateData
|
|
1838
|
+
): CancelablePromise<PriceControllerUpdateResponse> {
|
|
1839
|
+
return __request(OpenAPI, {
|
|
1840
|
+
method: 'PUT',
|
|
1841
|
+
url: '/api/v1/{region}/bean/prices/{id}',
|
|
1842
|
+
path: {
|
|
1843
|
+
id: data.id,
|
|
1844
|
+
region: data.region
|
|
1845
|
+
},
|
|
1846
|
+
body: data.requestBody,
|
|
1847
|
+
mediaType: 'application/json',
|
|
1848
|
+
errors: {
|
|
1849
|
+
404: 'Price not found',
|
|
1850
|
+
409: 'Updated price conflicts with existing price'
|
|
1851
|
+
}
|
|
1852
|
+
});
|
|
1853
|
+
}
|
|
1854
|
+
|
|
1855
|
+
/**
|
|
1856
|
+
* Delete a price
|
|
1857
|
+
* Deletes a price entry (hard delete)
|
|
1858
|
+
* @param data The data for the request.
|
|
1859
|
+
* @param data.id Price ID
|
|
1860
|
+
* @param data.region Region code for tenant context
|
|
1861
|
+
* @returns void Price deleted successfully
|
|
1862
|
+
* @throws ApiError
|
|
1863
|
+
*/
|
|
1864
|
+
public static priceControllerDelete(
|
|
1865
|
+
data: PriceControllerDeleteData
|
|
1866
|
+
): CancelablePromise<PriceControllerDeleteResponse> {
|
|
1867
|
+
return __request(OpenAPI, {
|
|
1868
|
+
method: 'DELETE',
|
|
1869
|
+
url: '/api/v1/{region}/bean/prices/{id}',
|
|
1870
|
+
path: {
|
|
1871
|
+
id: data.id,
|
|
1872
|
+
region: data.region
|
|
1873
|
+
},
|
|
1874
|
+
errors: {
|
|
1875
|
+
404: 'Price not found'
|
|
1876
|
+
}
|
|
1877
|
+
});
|
|
1878
|
+
}
|
|
1879
|
+
|
|
1880
|
+
/**
|
|
1881
|
+
* Bulk create prices
|
|
1882
|
+
* Creates multiple price entries at once (skips duplicates)
|
|
1883
|
+
* @param data The data for the request.
|
|
1884
|
+
* @param data.region Region code for tenant context
|
|
1885
|
+
* @param data.requestBody
|
|
1886
|
+
* @returns PriceResponseDto Prices created successfully
|
|
1887
|
+
* @throws ApiError
|
|
1888
|
+
*/
|
|
1889
|
+
public static priceControllerBulkCreate(
|
|
1890
|
+
data: PriceControllerBulkCreateData
|
|
1891
|
+
): CancelablePromise<PriceControllerBulkCreateResponse> {
|
|
1892
|
+
return __request(OpenAPI, {
|
|
1893
|
+
method: 'POST',
|
|
1894
|
+
url: '/api/v1/{region}/bean/prices/bulk',
|
|
1895
|
+
path: {
|
|
1896
|
+
region: data.region
|
|
1897
|
+
},
|
|
1898
|
+
body: data.requestBody,
|
|
1899
|
+
mediaType: 'application/json'
|
|
1900
|
+
});
|
|
1901
|
+
}
|
|
1902
|
+
}
|
|
1903
|
+
|
|
1904
|
+
export class UsersService {
|
|
1905
|
+
/**
|
|
1906
|
+
* Delete own user account
|
|
1907
|
+
* @param data The data for the request.
|
|
1908
|
+
* @param data.requestBody
|
|
1909
|
+
* @returns void User deleted successfully
|
|
1910
|
+
* @throws ApiError
|
|
1911
|
+
*/
|
|
1912
|
+
public static userControllerDeleteOwnUser(
|
|
1913
|
+
data: UserControllerDeleteOwnUserData
|
|
1914
|
+
): CancelablePromise<UserControllerDeleteOwnUserResponse> {
|
|
1915
|
+
return __request(OpenAPI, {
|
|
1916
|
+
method: 'DELETE',
|
|
1917
|
+
url: '/api/v1/users',
|
|
1918
|
+
body: data.requestBody,
|
|
1919
|
+
mediaType: 'application/json',
|
|
1920
|
+
errors: {
|
|
1921
|
+
403: 'Invalid access token'
|
|
1922
|
+
}
|
|
1923
|
+
});
|
|
1924
|
+
}
|
|
1925
|
+
|
|
1926
|
+
/**
|
|
1927
|
+
* Get current authenticated user
|
|
1928
|
+
* @param data The data for the request.
|
|
1929
|
+
* @param data.acceptLanguage
|
|
1930
|
+
* @returns UserResponseDto User retrieved successfully
|
|
1931
|
+
* @throws ApiError
|
|
1932
|
+
*/
|
|
1933
|
+
public static userControllerGetUser(
|
|
1934
|
+
data: UserControllerGetUserData
|
|
1935
|
+
): CancelablePromise<UserControllerGetUserResponse> {
|
|
1936
|
+
return __request(OpenAPI, {
|
|
1937
|
+
method: 'GET',
|
|
1938
|
+
url: '/api/v1/users',
|
|
1939
|
+
headers: {
|
|
1940
|
+
'accept-language': data.acceptLanguage
|
|
1941
|
+
}
|
|
1942
|
+
});
|
|
1943
|
+
}
|
|
1944
|
+
|
|
1945
|
+
/**
|
|
1946
|
+
* Sign up new user
|
|
1947
|
+
* Create a new account with auto-generated access token. Protected by Cloudflare Turnstile to prevent automated signup (when enabled).
|
|
1948
|
+
* @param data The data for the request.
|
|
1949
|
+
* @param data.requestBody
|
|
1950
|
+
* @returns SignupResponseDto User created successfully
|
|
1951
|
+
* @throws ApiError
|
|
1952
|
+
*/
|
|
1953
|
+
public static userControllerSignupUser(
|
|
1954
|
+
data: UserControllerSignupUserData
|
|
1955
|
+
): CancelablePromise<UserControllerSignupUserResponse> {
|
|
1956
|
+
return __request(OpenAPI, {
|
|
1957
|
+
method: 'POST',
|
|
1958
|
+
url: '/api/v1/users',
|
|
1959
|
+
body: data.requestBody,
|
|
1960
|
+
mediaType: 'application/json',
|
|
1961
|
+
errors: {
|
|
1962
|
+
400: 'Invalid Turnstile token (when Turnstile is enabled)',
|
|
1963
|
+
403: 'User signup is disabled'
|
|
1964
|
+
}
|
|
1965
|
+
});
|
|
1966
|
+
}
|
|
1967
|
+
|
|
1968
|
+
/**
|
|
1969
|
+
* Delete user by ID (admin only)
|
|
1970
|
+
* @param data The data for the request.
|
|
1971
|
+
* @param data.id User ID to delete
|
|
1972
|
+
* @returns void User deleted successfully
|
|
1973
|
+
* @throws ApiError
|
|
1974
|
+
*/
|
|
1975
|
+
public static userControllerDeleteUser(
|
|
1976
|
+
data: UserControllerDeleteUserData
|
|
1977
|
+
): CancelablePromise<UserControllerDeleteUserResponse> {
|
|
1978
|
+
return __request(OpenAPI, {
|
|
1979
|
+
method: 'DELETE',
|
|
1980
|
+
url: '/api/v1/users/{id}',
|
|
1981
|
+
path: {
|
|
1982
|
+
id: data.id
|
|
1983
|
+
},
|
|
1984
|
+
errors: {
|
|
1985
|
+
403: 'Cannot delete own account or insufficient permissions'
|
|
1986
|
+
}
|
|
1987
|
+
});
|
|
1988
|
+
}
|
|
1989
|
+
|
|
1990
|
+
/**
|
|
1991
|
+
* Get user info by user ID
|
|
1992
|
+
* @param data The data for the request.
|
|
1993
|
+
* @param data.id User ID
|
|
1994
|
+
* @returns unknown User info retrieved successfully
|
|
1995
|
+
* @throws ApiError
|
|
1996
|
+
*/
|
|
1997
|
+
public static userControllerGetUserInfo(
|
|
1998
|
+
data: UserControllerGetUserInfoData
|
|
1999
|
+
): CancelablePromise<UserControllerGetUserInfoResponse> {
|
|
2000
|
+
return __request(OpenAPI, {
|
|
2001
|
+
method: 'GET',
|
|
2002
|
+
url: '/api/v1/users/{id}/info',
|
|
2003
|
+
path: {
|
|
2004
|
+
id: data.id
|
|
2005
|
+
},
|
|
2006
|
+
errors: {
|
|
2007
|
+
403: 'Cannot access other user info without admin permission'
|
|
2008
|
+
}
|
|
2009
|
+
});
|
|
2010
|
+
}
|
|
2011
|
+
|
|
2012
|
+
/**
|
|
2013
|
+
* Update user settings
|
|
2014
|
+
* @param data The data for the request.
|
|
2015
|
+
* @param data.requestBody
|
|
2016
|
+
* @returns unknown Settings updated successfully
|
|
2017
|
+
* @throws ApiError
|
|
2018
|
+
*/
|
|
2019
|
+
public static userControllerUpdateUserSetting(
|
|
2020
|
+
data: UserControllerUpdateUserSettingData
|
|
2021
|
+
): CancelablePromise<UserControllerUpdateUserSettingResponse> {
|
|
2022
|
+
return __request(OpenAPI, {
|
|
2023
|
+
method: 'PUT',
|
|
2024
|
+
url: '/api/v1/users/setting',
|
|
2025
|
+
body: data.requestBody,
|
|
2026
|
+
mediaType: 'application/json',
|
|
2027
|
+
errors: {
|
|
2028
|
+
403: 'Insufficient permissions'
|
|
2029
|
+
}
|
|
2030
|
+
});
|
|
2031
|
+
}
|
|
2032
|
+
|
|
2033
|
+
/**
|
|
2034
|
+
* Get all user settings paginated (admin only)
|
|
2035
|
+
* @param data The data for the request.
|
|
2036
|
+
* @param data.pageNo Page number
|
|
2037
|
+
* @param data.pageSize Page size
|
|
2038
|
+
* @returns unknown Settings list retrieved successfully
|
|
2039
|
+
* @throws ApiError
|
|
2040
|
+
*/
|
|
2041
|
+
public static userControllerGetAllUserSettingsByPage(
|
|
2042
|
+
data: UserControllerGetAllUserSettingsByPageData
|
|
2043
|
+
): CancelablePromise<UserControllerGetAllUserSettingsByPageResponse> {
|
|
2044
|
+
return __request(OpenAPI, {
|
|
2045
|
+
method: 'GET',
|
|
2046
|
+
url: '/api/v1/users/settings-by-page',
|
|
2047
|
+
query: {
|
|
2048
|
+
pageNo: data.pageNo,
|
|
2049
|
+
pageSize: data.pageSize
|
|
2050
|
+
}
|
|
2051
|
+
});
|
|
2052
|
+
}
|
|
2053
|
+
|
|
2054
|
+
/**
|
|
2055
|
+
* Get asset and liability summary for current user
|
|
2056
|
+
* @returns unknown Summary retrieved successfully
|
|
2057
|
+
* @throws ApiError
|
|
2058
|
+
*/
|
|
2059
|
+
public static userControllerGetAssetLiabilitySummary(): CancelablePromise<UserControllerGetAssetLiabilitySummaryResponse> {
|
|
2060
|
+
return __request(OpenAPI, {
|
|
2061
|
+
method: 'GET',
|
|
2062
|
+
url: '/api/v1/users/asset-liability-summary'
|
|
2063
|
+
});
|
|
2064
|
+
}
|
|
2065
|
+
}
|
|
2066
|
+
|
|
2067
|
+
export class PropertiesService {
|
|
2068
|
+
/**
|
|
2069
|
+
* Get all system properties
|
|
2070
|
+
* @returns unknown Properties retrieved successfully
|
|
2071
|
+
* @throws ApiError
|
|
2072
|
+
*/
|
|
2073
|
+
public static propertyControllerGetAll(): CancelablePromise<PropertyControllerGetAllResponse> {
|
|
2074
|
+
return __request(OpenAPI, {
|
|
2075
|
+
method: 'GET',
|
|
2076
|
+
url: '/api/v1/admin/properties',
|
|
2077
|
+
errors: {
|
|
2078
|
+
401: 'Unauthorized',
|
|
2079
|
+
403: 'Forbidden - insufficient permissions'
|
|
2080
|
+
}
|
|
2081
|
+
});
|
|
2082
|
+
}
|
|
2083
|
+
|
|
2084
|
+
/**
|
|
2085
|
+
* Get property by key
|
|
2086
|
+
* @param data The data for the request.
|
|
2087
|
+
* @param data.key Property key
|
|
2088
|
+
* @returns unknown Property retrieved successfully
|
|
2089
|
+
* @throws ApiError
|
|
2090
|
+
*/
|
|
2091
|
+
public static propertyControllerGetByKey(
|
|
2092
|
+
data: PropertyControllerGetByKeyData
|
|
2093
|
+
): CancelablePromise<PropertyControllerGetByKeyResponse> {
|
|
2094
|
+
return __request(OpenAPI, {
|
|
2095
|
+
method: 'GET',
|
|
2096
|
+
url: '/api/v1/admin/properties/{key}',
|
|
2097
|
+
path: {
|
|
2098
|
+
key: data.key
|
|
2099
|
+
},
|
|
2100
|
+
errors: {
|
|
2101
|
+
401: 'Unauthorized',
|
|
2102
|
+
403: 'Forbidden - insufficient permissions',
|
|
2103
|
+
404: 'Property not found'
|
|
2104
|
+
}
|
|
2105
|
+
});
|
|
2106
|
+
}
|
|
2107
|
+
|
|
2108
|
+
/**
|
|
2109
|
+
* Update a system property
|
|
2110
|
+
* @param data The data for the request.
|
|
2111
|
+
* @param data.key Property key
|
|
2112
|
+
* @param data.requestBody
|
|
2113
|
+
* @returns unknown Property updated successfully
|
|
2114
|
+
* @throws ApiError
|
|
2115
|
+
*/
|
|
2116
|
+
public static propertyControllerUpdate(
|
|
2117
|
+
data: PropertyControllerUpdateData
|
|
2118
|
+
): CancelablePromise<PropertyControllerUpdateResponse> {
|
|
2119
|
+
return __request(OpenAPI, {
|
|
2120
|
+
method: 'PUT',
|
|
2121
|
+
url: '/api/v1/admin/properties/{key}',
|
|
2122
|
+
path: {
|
|
2123
|
+
key: data.key
|
|
2124
|
+
},
|
|
2125
|
+
body: data.requestBody,
|
|
2126
|
+
mediaType: 'application/json',
|
|
2127
|
+
errors: {
|
|
2128
|
+
401: 'Unauthorized',
|
|
2129
|
+
403: 'Forbidden - insufficient permissions'
|
|
2130
|
+
}
|
|
2131
|
+
});
|
|
2132
|
+
}
|
|
2133
|
+
|
|
2134
|
+
/**
|
|
2135
|
+
* Delete a system property
|
|
2136
|
+
* @param data The data for the request.
|
|
2137
|
+
* @param data.key Property key
|
|
2138
|
+
* @returns void Property deleted successfully
|
|
2139
|
+
* @throws ApiError
|
|
2140
|
+
*/
|
|
2141
|
+
public static propertyControllerDelete(
|
|
2142
|
+
data: PropertyControllerDeleteData
|
|
2143
|
+
): CancelablePromise<PropertyControllerDeleteResponse> {
|
|
2144
|
+
return __request(OpenAPI, {
|
|
2145
|
+
method: 'DELETE',
|
|
2146
|
+
url: '/api/v1/admin/properties/{key}',
|
|
2147
|
+
path: {
|
|
2148
|
+
key: data.key
|
|
2149
|
+
},
|
|
2150
|
+
errors: {
|
|
2151
|
+
401: 'Unauthorized',
|
|
2152
|
+
403: 'Forbidden - insufficient permissions',
|
|
2153
|
+
404: 'Property not found'
|
|
2154
|
+
}
|
|
2155
|
+
});
|
|
2156
|
+
}
|
|
2157
|
+
}
|
|
2158
|
+
|
|
2159
|
+
export class RecurringRulesService {
|
|
2160
|
+
/**
|
|
2161
|
+
* Create a new recurring rule
|
|
2162
|
+
* Creates a new recurring transaction rule for the authenticated user
|
|
2163
|
+
* @param data The data for the request.
|
|
2164
|
+
* @param data.region Region code for tenant context
|
|
2165
|
+
* @param data.requestBody
|
|
2166
|
+
* @returns RecurringRuleResponseDto Rule created successfully
|
|
2167
|
+
* @throws ApiError
|
|
2168
|
+
*/
|
|
2169
|
+
public static recurringRuleControllerCreate(
|
|
2170
|
+
data: RecurringRuleControllerCreateData
|
|
2171
|
+
): CancelablePromise<RecurringRuleControllerCreateResponse> {
|
|
2172
|
+
return __request(OpenAPI, {
|
|
2173
|
+
method: 'POST',
|
|
2174
|
+
url: '/api/v1/{region}/bean/recurring-rules',
|
|
2175
|
+
path: {
|
|
2176
|
+
region: data.region
|
|
2177
|
+
},
|
|
2178
|
+
body: data.requestBody,
|
|
2179
|
+
mediaType: 'application/json',
|
|
2180
|
+
errors: {
|
|
2181
|
+
400: 'Invalid input data (e.g., autoCreate without accounts)',
|
|
2182
|
+
409: 'Rule with same name already exists'
|
|
2183
|
+
}
|
|
2184
|
+
});
|
|
2185
|
+
}
|
|
2186
|
+
|
|
2187
|
+
/**
|
|
2188
|
+
* List recurring rules
|
|
2189
|
+
* Returns all recurring rules for the authenticated user with optional filtering
|
|
2190
|
+
* @param data The data for the request.
|
|
2191
|
+
* @param data.region Region code for tenant context
|
|
2192
|
+
* @param data.isActive Filter by active status
|
|
2193
|
+
* @param data.frequency Filter by frequency (WEEKLY, MONTHLY, etc.)
|
|
2194
|
+
* @param data.hasAutoCreate Filter by autoCreate enabled
|
|
2195
|
+
* @returns RecurringRuleResponseDto Rules retrieved successfully
|
|
2196
|
+
* @throws ApiError
|
|
2197
|
+
*/
|
|
2198
|
+
public static recurringRuleControllerFindAll(
|
|
2199
|
+
data: RecurringRuleControllerFindAllData
|
|
2200
|
+
): CancelablePromise<RecurringRuleControllerFindAllResponse> {
|
|
2201
|
+
return __request(OpenAPI, {
|
|
2202
|
+
method: 'GET',
|
|
2203
|
+
url: '/api/v1/{region}/bean/recurring-rules',
|
|
2204
|
+
path: {
|
|
2205
|
+
region: data.region
|
|
2206
|
+
},
|
|
2207
|
+
query: {
|
|
2208
|
+
isActive: data.isActive,
|
|
2209
|
+
frequency: data.frequency,
|
|
2210
|
+
hasAutoCreate: data.hasAutoCreate
|
|
2211
|
+
}
|
|
2212
|
+
});
|
|
2213
|
+
}
|
|
2214
|
+
|
|
2215
|
+
/**
|
|
2216
|
+
* Create recurring rule from transaction
|
|
2217
|
+
* Auto-creates a recurring rule using transaction data. User only confirms frequency.
|
|
2218
|
+
* @param data The data for the request.
|
|
2219
|
+
* @param data.transactionId Source transaction ID
|
|
2220
|
+
* @param data.region Region code for tenant context
|
|
2221
|
+
* @param data.requestBody
|
|
2222
|
+
* @returns RecurringRuleResponseDto Rule created successfully
|
|
2223
|
+
* @throws ApiError
|
|
2224
|
+
*/
|
|
2225
|
+
public static recurringRuleControllerCreateFromTransaction(
|
|
2226
|
+
data: RecurringRuleControllerCreateFromTransactionData
|
|
2227
|
+
): CancelablePromise<RecurringRuleControllerCreateFromTransactionResponse> {
|
|
2228
|
+
return __request(OpenAPI, {
|
|
2229
|
+
method: 'POST',
|
|
2230
|
+
url: '/api/v1/{region}/bean/recurring-rules/from-transaction/{transactionId}',
|
|
2231
|
+
path: {
|
|
2232
|
+
transactionId: data.transactionId,
|
|
2233
|
+
region: data.region
|
|
2234
|
+
},
|
|
2235
|
+
body: data.requestBody,
|
|
2236
|
+
mediaType: 'application/json',
|
|
2237
|
+
errors: {
|
|
2238
|
+
404: 'Transaction not found',
|
|
2239
|
+
409: 'Rule with same name already exists or transaction already linked'
|
|
2240
|
+
}
|
|
2241
|
+
});
|
|
2242
|
+
}
|
|
2243
|
+
|
|
2244
|
+
/**
|
|
2245
|
+
* Get recurring rule by ID
|
|
2246
|
+
* Returns a specific recurring rule with its details
|
|
2247
|
+
* @param data The data for the request.
|
|
2248
|
+
* @param data.id Rule ID
|
|
1604
2249
|
* @param data.region Region code for tenant context
|
|
1605
2250
|
* @returns RecurringRuleResponseDto Rule retrieved successfully
|
|
1606
2251
|
* @throws ApiError
|
|
@@ -1809,7 +2454,7 @@ export class ExpectedTransactionsService {
|
|
|
1809
2454
|
* @param data The data for the request.
|
|
1810
2455
|
* @param data.id Expected transaction ID
|
|
1811
2456
|
* @param data.region Region code for tenant context
|
|
1812
|
-
* @returns
|
|
2457
|
+
* @returns void Skip undone successfully
|
|
1813
2458
|
* @throws ApiError
|
|
1814
2459
|
*/
|
|
1815
2460
|
public static expectedTransactionControllerUndoSkip(
|
|
@@ -1865,7 +2510,7 @@ export class ExpectedTransactionsService {
|
|
|
1865
2510
|
* @param data The data for the request.
|
|
1866
2511
|
* @param data.id Expected transaction ID
|
|
1867
2512
|
* @param data.region Region code for tenant context
|
|
1868
|
-
* @returns
|
|
2513
|
+
* @returns void Match removed successfully
|
|
1869
2514
|
* @throws ApiError
|
|
1870
2515
|
*/
|
|
1871
2516
|
public static expectedTransactionControllerUnmatch(
|
|
@@ -2170,305 +2815,78 @@ export class BeanTransactionRulesService {
|
|
|
2170
2815
|
* @returns void Rule deleted successfully
|
|
2171
2816
|
* @throws ApiError
|
|
2172
2817
|
*/
|
|
2173
|
-
public static transactionRuleControllerDelete(
|
|
2174
|
-
data: TransactionRuleControllerDeleteData
|
|
2175
|
-
): CancelablePromise<TransactionRuleControllerDeleteResponse> {
|
|
2176
|
-
return __request(OpenAPI, {
|
|
2177
|
-
method: 'DELETE',
|
|
2178
|
-
url: '/api/v1/{region}/bean/transaction-rules/{ruleId}',
|
|
2179
|
-
path: {
|
|
2180
|
-
ruleId: data.ruleId,
|
|
2181
|
-
region: data.region
|
|
2182
|
-
},
|
|
2183
|
-
errors: {
|
|
2184
|
-
401: 'Unauthorized',
|
|
2185
|
-
403: 'Forbidden - not owner of rule',
|
|
2186
|
-
404: 'Rule not found',
|
|
2187
|
-
409: 'Resource conflict - rule is being modified by another process'
|
|
2188
|
-
}
|
|
2189
|
-
});
|
|
2190
|
-
}
|
|
2191
|
-
|
|
2192
|
-
/**
|
|
2193
|
-
* Test rule matching
|
|
2194
|
-
* @param data The data for the request.
|
|
2195
|
-
* @param data.ruleId Rule ID to test
|
|
2196
|
-
* @param data.region Region code for tenant context
|
|
2197
|
-
* @param data.requestBody
|
|
2198
|
-
* @returns TestRuleResponseDto Test result
|
|
2199
|
-
* @throws ApiError
|
|
2200
|
-
*/
|
|
2201
|
-
public static transactionRuleControllerTest(
|
|
2202
|
-
data: TransactionRuleControllerTestData
|
|
2203
|
-
): CancelablePromise<TransactionRuleControllerTestResponse> {
|
|
2204
|
-
return __request(OpenAPI, {
|
|
2205
|
-
method: 'POST',
|
|
2206
|
-
url: '/api/v1/{region}/bean/transaction-rules/{ruleId}/test',
|
|
2207
|
-
path: {
|
|
2208
|
-
ruleId: data.ruleId,
|
|
2209
|
-
region: data.region
|
|
2210
|
-
},
|
|
2211
|
-
body: data.requestBody,
|
|
2212
|
-
mediaType: 'application/json',
|
|
2213
|
-
errors: {
|
|
2214
|
-
401: 'Unauthorized',
|
|
2215
|
-
403: 'Forbidden - not owner of rule',
|
|
2216
|
-
404: 'Rule not found'
|
|
2217
|
-
}
|
|
2218
|
-
});
|
|
2219
|
-
}
|
|
2220
|
-
}
|
|
2221
|
-
|
|
2222
|
-
export class UsersService {
|
|
2223
|
-
/**
|
|
2224
|
-
* Delete own user account
|
|
2225
|
-
* @param data The data for the request.
|
|
2226
|
-
* @param data.requestBody
|
|
2227
|
-
* @returns void User deleted successfully
|
|
2228
|
-
* @throws ApiError
|
|
2229
|
-
*/
|
|
2230
|
-
public static userControllerDeleteOwnUser(
|
|
2231
|
-
data: UserControllerDeleteOwnUserData
|
|
2232
|
-
): CancelablePromise<UserControllerDeleteOwnUserResponse> {
|
|
2233
|
-
return __request(OpenAPI, {
|
|
2234
|
-
method: 'DELETE',
|
|
2235
|
-
url: '/api/v1/users',
|
|
2236
|
-
body: data.requestBody,
|
|
2237
|
-
mediaType: 'application/json',
|
|
2238
|
-
errors: {
|
|
2239
|
-
403: 'Invalid access token'
|
|
2240
|
-
}
|
|
2241
|
-
});
|
|
2242
|
-
}
|
|
2243
|
-
|
|
2244
|
-
/**
|
|
2245
|
-
* Get current authenticated user
|
|
2246
|
-
* @param data The data for the request.
|
|
2247
|
-
* @param data.acceptLanguage
|
|
2248
|
-
* @returns unknown User retrieved successfully
|
|
2249
|
-
* @throws ApiError
|
|
2250
|
-
*/
|
|
2251
|
-
public static userControllerGetUser(
|
|
2252
|
-
data: UserControllerGetUserData
|
|
2253
|
-
): CancelablePromise<UserControllerGetUserResponse> {
|
|
2254
|
-
return __request(OpenAPI, {
|
|
2255
|
-
method: 'GET',
|
|
2256
|
-
url: '/api/v1/users',
|
|
2257
|
-
headers: {
|
|
2258
|
-
'accept-language': data.acceptLanguage
|
|
2259
|
-
}
|
|
2260
|
-
});
|
|
2261
|
-
}
|
|
2262
|
-
|
|
2263
|
-
/**
|
|
2264
|
-
* Sign up new user
|
|
2265
|
-
* Create a new account with auto-generated access token. Protected by Cloudflare Turnstile to prevent automated signup (when enabled).
|
|
2266
|
-
* @param data The data for the request.
|
|
2267
|
-
* @param data.requestBody
|
|
2268
|
-
* @returns unknown User created successfully
|
|
2269
|
-
* @throws ApiError
|
|
2270
|
-
*/
|
|
2271
|
-
public static userControllerSignupUser(
|
|
2272
|
-
data: UserControllerSignupUserData
|
|
2273
|
-
): CancelablePromise<UserControllerSignupUserResponse> {
|
|
2274
|
-
return __request(OpenAPI, {
|
|
2275
|
-
method: 'POST',
|
|
2276
|
-
url: '/api/v1/users',
|
|
2277
|
-
body: data.requestBody,
|
|
2278
|
-
mediaType: 'application/json',
|
|
2279
|
-
errors: {
|
|
2280
|
-
400: 'Invalid Turnstile token (when Turnstile is enabled)',
|
|
2281
|
-
403: 'User signup is disabled'
|
|
2282
|
-
}
|
|
2283
|
-
});
|
|
2284
|
-
}
|
|
2285
|
-
|
|
2286
|
-
/**
|
|
2287
|
-
* Delete user by ID (admin only)
|
|
2288
|
-
* @param data The data for the request.
|
|
2289
|
-
* @param data.id User ID to delete
|
|
2290
|
-
* @returns void User deleted successfully
|
|
2291
|
-
* @throws ApiError
|
|
2292
|
-
*/
|
|
2293
|
-
public static userControllerDeleteUser(
|
|
2294
|
-
data: UserControllerDeleteUserData
|
|
2295
|
-
): CancelablePromise<UserControllerDeleteUserResponse> {
|
|
2296
|
-
return __request(OpenAPI, {
|
|
2297
|
-
method: 'DELETE',
|
|
2298
|
-
url: '/api/v1/users/{id}',
|
|
2299
|
-
path: {
|
|
2300
|
-
id: data.id
|
|
2301
|
-
},
|
|
2302
|
-
errors: {
|
|
2303
|
-
403: 'Cannot delete own account or insufficient permissions'
|
|
2304
|
-
}
|
|
2305
|
-
});
|
|
2306
|
-
}
|
|
2307
|
-
|
|
2308
|
-
/**
|
|
2309
|
-
* Get user info by user ID
|
|
2310
|
-
* @param data The data for the request.
|
|
2311
|
-
* @param data.id User ID
|
|
2312
|
-
* @returns unknown User info retrieved successfully
|
|
2313
|
-
* @throws ApiError
|
|
2314
|
-
*/
|
|
2315
|
-
public static userControllerGetUserInfo(
|
|
2316
|
-
data: UserControllerGetUserInfoData
|
|
2317
|
-
): CancelablePromise<UserControllerGetUserInfoResponse> {
|
|
2318
|
-
return __request(OpenAPI, {
|
|
2319
|
-
method: 'GET',
|
|
2320
|
-
url: '/api/v1/users/{id}/info',
|
|
2321
|
-
path: {
|
|
2322
|
-
id: data.id
|
|
2323
|
-
},
|
|
2324
|
-
errors: {
|
|
2325
|
-
403: 'Cannot access other user info without admin permission'
|
|
2326
|
-
}
|
|
2327
|
-
});
|
|
2328
|
-
}
|
|
2329
|
-
|
|
2330
|
-
/**
|
|
2331
|
-
* Update user settings
|
|
2332
|
-
* @param data The data for the request.
|
|
2333
|
-
* @param data.requestBody
|
|
2334
|
-
* @returns unknown Settings updated successfully
|
|
2335
|
-
* @throws ApiError
|
|
2336
|
-
*/
|
|
2337
|
-
public static userControllerUpdateUserSetting(
|
|
2338
|
-
data: UserControllerUpdateUserSettingData
|
|
2339
|
-
): CancelablePromise<UserControllerUpdateUserSettingResponse> {
|
|
2340
|
-
return __request(OpenAPI, {
|
|
2341
|
-
method: 'PUT',
|
|
2342
|
-
url: '/api/v1/users/setting',
|
|
2343
|
-
body: data.requestBody,
|
|
2344
|
-
mediaType: 'application/json',
|
|
2345
|
-
errors: {
|
|
2346
|
-
403: 'Insufficient permissions'
|
|
2347
|
-
}
|
|
2348
|
-
});
|
|
2349
|
-
}
|
|
2350
|
-
|
|
2351
|
-
/**
|
|
2352
|
-
* Get all user settings paginated (admin only)
|
|
2353
|
-
* @param data The data for the request.
|
|
2354
|
-
* @param data.pageNo Page number
|
|
2355
|
-
* @param data.pageSize Page size
|
|
2356
|
-
* @returns unknown Settings list retrieved successfully
|
|
2357
|
-
* @throws ApiError
|
|
2358
|
-
*/
|
|
2359
|
-
public static userControllerGetAllUserSettingsByPage(
|
|
2360
|
-
data: UserControllerGetAllUserSettingsByPageData
|
|
2361
|
-
): CancelablePromise<UserControllerGetAllUserSettingsByPageResponse> {
|
|
2362
|
-
return __request(OpenAPI, {
|
|
2363
|
-
method: 'GET',
|
|
2364
|
-
url: '/api/v1/users/settings-by-page',
|
|
2365
|
-
query: {
|
|
2366
|
-
pageNo: data.pageNo,
|
|
2367
|
-
pageSize: data.pageSize
|
|
2368
|
-
}
|
|
2369
|
-
});
|
|
2370
|
-
}
|
|
2371
|
-
|
|
2372
|
-
/**
|
|
2373
|
-
* Get asset and liability summary for current user
|
|
2374
|
-
* @returns unknown Summary retrieved successfully
|
|
2375
|
-
* @throws ApiError
|
|
2376
|
-
*/
|
|
2377
|
-
public static userControllerGetAssetLiabilitySummary(): CancelablePromise<UserControllerGetAssetLiabilitySummaryResponse> {
|
|
2378
|
-
return __request(OpenAPI, {
|
|
2379
|
-
method: 'GET',
|
|
2380
|
-
url: '/api/v1/users/asset-liability-summary'
|
|
2381
|
-
});
|
|
2382
|
-
}
|
|
2383
|
-
}
|
|
2384
|
-
|
|
2385
|
-
export class PropertiesService {
|
|
2386
|
-
/**
|
|
2387
|
-
* Get all system properties
|
|
2388
|
-
* @returns unknown Properties retrieved successfully
|
|
2389
|
-
* @throws ApiError
|
|
2390
|
-
*/
|
|
2391
|
-
public static propertyControllerGetAll(): CancelablePromise<PropertyControllerGetAllResponse> {
|
|
2392
|
-
return __request(OpenAPI, {
|
|
2393
|
-
method: 'GET',
|
|
2394
|
-
url: '/api/v1/admin/properties',
|
|
2395
|
-
errors: {
|
|
2396
|
-
401: 'Unauthorized',
|
|
2397
|
-
403: 'Forbidden - insufficient permissions'
|
|
2398
|
-
}
|
|
2399
|
-
});
|
|
2400
|
-
}
|
|
2401
|
-
|
|
2402
|
-
/**
|
|
2403
|
-
* Get property by key
|
|
2404
|
-
* @param data The data for the request.
|
|
2405
|
-
* @param data.key Property key
|
|
2406
|
-
* @returns unknown Property retrieved successfully
|
|
2407
|
-
* @throws ApiError
|
|
2408
|
-
*/
|
|
2409
|
-
public static propertyControllerGetByKey(
|
|
2410
|
-
data: PropertyControllerGetByKeyData
|
|
2411
|
-
): CancelablePromise<PropertyControllerGetByKeyResponse> {
|
|
2818
|
+
public static transactionRuleControllerDelete(
|
|
2819
|
+
data: TransactionRuleControllerDeleteData
|
|
2820
|
+
): CancelablePromise<TransactionRuleControllerDeleteResponse> {
|
|
2412
2821
|
return __request(OpenAPI, {
|
|
2413
|
-
method: '
|
|
2414
|
-
url: '/api/v1/
|
|
2822
|
+
method: 'DELETE',
|
|
2823
|
+
url: '/api/v1/{region}/bean/transaction-rules/{ruleId}',
|
|
2415
2824
|
path: {
|
|
2416
|
-
|
|
2825
|
+
ruleId: data.ruleId,
|
|
2826
|
+
region: data.region
|
|
2417
2827
|
},
|
|
2418
2828
|
errors: {
|
|
2419
2829
|
401: 'Unauthorized',
|
|
2420
|
-
403: 'Forbidden -
|
|
2421
|
-
404: '
|
|
2830
|
+
403: 'Forbidden - not owner of rule',
|
|
2831
|
+
404: 'Rule not found',
|
|
2832
|
+
409: 'Resource conflict - rule is being modified by another process'
|
|
2422
2833
|
}
|
|
2423
2834
|
});
|
|
2424
2835
|
}
|
|
2425
2836
|
|
|
2426
2837
|
/**
|
|
2427
|
-
*
|
|
2838
|
+
* Test rule matching
|
|
2428
2839
|
* @param data The data for the request.
|
|
2429
|
-
* @param data.
|
|
2840
|
+
* @param data.ruleId Rule ID to test
|
|
2841
|
+
* @param data.region Region code for tenant context
|
|
2430
2842
|
* @param data.requestBody
|
|
2431
|
-
* @returns
|
|
2843
|
+
* @returns TestRuleResponseDto Test result
|
|
2432
2844
|
* @throws ApiError
|
|
2433
2845
|
*/
|
|
2434
|
-
public static
|
|
2435
|
-
data:
|
|
2436
|
-
): CancelablePromise<
|
|
2846
|
+
public static transactionRuleControllerTest(
|
|
2847
|
+
data: TransactionRuleControllerTestData
|
|
2848
|
+
): CancelablePromise<TransactionRuleControllerTestResponse> {
|
|
2437
2849
|
return __request(OpenAPI, {
|
|
2438
|
-
method: '
|
|
2439
|
-
url: '/api/v1/
|
|
2850
|
+
method: 'POST',
|
|
2851
|
+
url: '/api/v1/{region}/bean/transaction-rules/{ruleId}/test',
|
|
2440
2852
|
path: {
|
|
2441
|
-
|
|
2853
|
+
ruleId: data.ruleId,
|
|
2854
|
+
region: data.region
|
|
2442
2855
|
},
|
|
2443
2856
|
body: data.requestBody,
|
|
2444
2857
|
mediaType: 'application/json',
|
|
2445
2858
|
errors: {
|
|
2446
2859
|
401: 'Unauthorized',
|
|
2447
|
-
403: 'Forbidden -
|
|
2860
|
+
403: 'Forbidden - not owner of rule',
|
|
2861
|
+
404: 'Rule not found'
|
|
2448
2862
|
}
|
|
2449
2863
|
});
|
|
2450
2864
|
}
|
|
2865
|
+
}
|
|
2451
2866
|
|
|
2867
|
+
export class BeanCategoryCatalogService {
|
|
2452
2868
|
/**
|
|
2453
|
-
*
|
|
2869
|
+
* List category catalog for a region
|
|
2870
|
+
* Returns the region-scoped category slugs (expense/income/investment/banking/transfer/payment) for the NLP result picker, each with the categoryAccount paths the region-enabled system rules map it to (#816). CN-exclusive payment instruments (huabei/baitiao) appear only under /cn.
|
|
2454
2871
|
* @param data The data for the request.
|
|
2455
|
-
* @param data.
|
|
2456
|
-
* @
|
|
2872
|
+
* @param data.region Region code for tenant context
|
|
2873
|
+
* @param data.scenario Filter by scenario
|
|
2874
|
+
* @param data.routeBearing Filter by routeBearing (entity-router route() consumes it)
|
|
2875
|
+
* @returns CategoryCatalogListResponseDto Category catalog retrieved successfully
|
|
2457
2876
|
* @throws ApiError
|
|
2458
2877
|
*/
|
|
2459
|
-
public static
|
|
2460
|
-
data:
|
|
2461
|
-
): CancelablePromise<
|
|
2878
|
+
public static categoryCatalogControllerList(
|
|
2879
|
+
data: CategoryCatalogControllerListData
|
|
2880
|
+
): CancelablePromise<CategoryCatalogControllerListResponse> {
|
|
2462
2881
|
return __request(OpenAPI, {
|
|
2463
|
-
method: '
|
|
2464
|
-
url: '/api/v1/
|
|
2882
|
+
method: 'GET',
|
|
2883
|
+
url: '/api/v1/{region}/bean/categories',
|
|
2465
2884
|
path: {
|
|
2466
|
-
|
|
2885
|
+
region: data.region
|
|
2467
2886
|
},
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
|
|
2471
|
-
404: 'Property not found'
|
|
2887
|
+
query: {
|
|
2888
|
+
scenario: data.scenario,
|
|
2889
|
+
routeBearing: data.routeBearing
|
|
2472
2890
|
}
|
|
2473
2891
|
});
|
|
2474
2892
|
}
|
|
@@ -2649,11 +3067,144 @@ export class LifeEventsService {
|
|
|
2649
3067
|
}
|
|
2650
3068
|
}
|
|
2651
3069
|
|
|
3070
|
+
export class OnboardingService {
|
|
3071
|
+
/**
|
|
3072
|
+
* Bootstrap core accounts + register asset accounts with opening balances (ADR-0113)
|
|
3073
|
+
* @param data The data for the request.
|
|
3074
|
+
* @param data.region Region code for tenant context. Not-yet-open codes are accepted: the universal catalog backs onboarding regardless of region (#759)
|
|
3075
|
+
* @param data.requestBody
|
|
3076
|
+
* @returns unknown Onboarding bootstrap result.
|
|
3077
|
+
* @throws ApiError
|
|
3078
|
+
*/
|
|
3079
|
+
public static onboardingControllerBootstrap(
|
|
3080
|
+
data: OnboardingControllerBootstrapData
|
|
3081
|
+
): CancelablePromise<OnboardingControllerBootstrapResponse> {
|
|
3082
|
+
return __request(OpenAPI, {
|
|
3083
|
+
method: 'POST',
|
|
3084
|
+
url: '/api/v1/{region}/bean/onboarding',
|
|
3085
|
+
path: {
|
|
3086
|
+
region: data.region
|
|
3087
|
+
},
|
|
3088
|
+
body: data.requestBody,
|
|
3089
|
+
mediaType: 'application/json',
|
|
3090
|
+
errors: {
|
|
3091
|
+
422: 'Invalid region/account path/duplicate paths.'
|
|
3092
|
+
}
|
|
3093
|
+
});
|
|
3094
|
+
}
|
|
3095
|
+
}
|
|
3096
|
+
|
|
3097
|
+
export class BalanceReconciliationService {
|
|
3098
|
+
/**
|
|
3099
|
+
* Preview reconciliation (book vs actual)
|
|
3100
|
+
* Computes book balance, diff, Beancount-inferred tolerance, and suggested action without persisting.
|
|
3101
|
+
* @param data The data for the request.
|
|
3102
|
+
* @param data.region Region code for tenant context (decorative for reconciliation)
|
|
3103
|
+
* @param data.requestBody
|
|
3104
|
+
* @returns ReconciliationComputeResultDto Reconciliation preview
|
|
3105
|
+
* @throws ApiError
|
|
3106
|
+
*/
|
|
3107
|
+
public static reconciliationControllerCompute(
|
|
3108
|
+
data: ReconciliationControllerComputeData
|
|
3109
|
+
): CancelablePromise<ReconciliationControllerComputeResponse> {
|
|
3110
|
+
return __request(OpenAPI, {
|
|
3111
|
+
method: 'POST',
|
|
3112
|
+
url: '/api/v1/{region}/bean/reconciliations',
|
|
3113
|
+
path: {
|
|
3114
|
+
region: data.region
|
|
3115
|
+
},
|
|
3116
|
+
body: data.requestBody,
|
|
3117
|
+
mediaType: 'application/json',
|
|
3118
|
+
errors: {
|
|
3119
|
+
404: 'Account not found'
|
|
3120
|
+
}
|
|
3121
|
+
});
|
|
3122
|
+
}
|
|
3123
|
+
|
|
3124
|
+
/**
|
|
3125
|
+
* Record a balance assertion
|
|
3126
|
+
* Persists the reconciliation as a BeanBalance assertion (amount = actual, diffAmount = book − actual). Re-reconciling the same day/currency upserts.
|
|
3127
|
+
* @param data The data for the request.
|
|
3128
|
+
* @param data.region Region code for tenant context (decorative for reconciliation)
|
|
3129
|
+
* @param data.requestBody
|
|
3130
|
+
* @returns ReconciliationRecordDto Balance assertion recorded
|
|
3131
|
+
* @throws ApiError
|
|
3132
|
+
*/
|
|
3133
|
+
public static reconciliationControllerAssert(
|
|
3134
|
+
data: ReconciliationControllerAssertData
|
|
3135
|
+
): CancelablePromise<ReconciliationControllerAssertResponse> {
|
|
3136
|
+
return __request(OpenAPI, {
|
|
3137
|
+
method: 'POST',
|
|
3138
|
+
url: '/api/v1/{region}/bean/reconciliations/assert',
|
|
3139
|
+
path: {
|
|
3140
|
+
region: data.region
|
|
3141
|
+
},
|
|
3142
|
+
body: data.requestBody,
|
|
3143
|
+
mediaType: 'application/json',
|
|
3144
|
+
errors: {
|
|
3145
|
+
404: 'Account not found'
|
|
3146
|
+
}
|
|
3147
|
+
});
|
|
3148
|
+
}
|
|
3149
|
+
|
|
3150
|
+
/**
|
|
3151
|
+
* Generate a pad adjusting entry
|
|
3152
|
+
* When book is outside tolerance, synthesizes a Beancount pad transaction (flag P) booking the diff from source_account and persists it. Source defaults to Equity:Opening-Balances.
|
|
3153
|
+
* @param data The data for the request.
|
|
3154
|
+
* @param data.region Region code for tenant context (decorative for reconciliation)
|
|
3155
|
+
* @param data.requestBody
|
|
3156
|
+
* @returns PadResultDto Pad adjusting entry generated
|
|
3157
|
+
* @throws ApiError
|
|
3158
|
+
*/
|
|
3159
|
+
public static reconciliationControllerPad(
|
|
3160
|
+
data: ReconciliationControllerPadData
|
|
3161
|
+
): CancelablePromise<ReconciliationControllerPadResponse> {
|
|
3162
|
+
return __request(OpenAPI, {
|
|
3163
|
+
method: 'POST',
|
|
3164
|
+
url: '/api/v1/{region}/bean/reconciliations/pad',
|
|
3165
|
+
path: {
|
|
3166
|
+
region: data.region
|
|
3167
|
+
},
|
|
3168
|
+
body: data.requestBody,
|
|
3169
|
+
mediaType: 'application/json',
|
|
3170
|
+
errors: {
|
|
3171
|
+
400: 'Book already within tolerance — no pad needed',
|
|
3172
|
+
404: 'Account not found'
|
|
3173
|
+
}
|
|
3174
|
+
});
|
|
3175
|
+
}
|
|
3176
|
+
|
|
3177
|
+
/**
|
|
3178
|
+
* List reconciliation history for an account
|
|
3179
|
+
* Returns recorded balance assertions (most recent first). The latest drives the account-detail "Last <date>" badge.
|
|
3180
|
+
* @param data The data for the request.
|
|
3181
|
+
* @param data.accountId BeanAccount id
|
|
3182
|
+
* @param data.region Region code for tenant context (decorative for reconciliation)
|
|
3183
|
+
* @returns ReconciliationRecordDto Reconciliation history
|
|
3184
|
+
* @throws ApiError
|
|
3185
|
+
*/
|
|
3186
|
+
public static reconciliationControllerHistory(
|
|
3187
|
+
data: ReconciliationControllerHistoryData
|
|
3188
|
+
): CancelablePromise<ReconciliationControllerHistoryResponse> {
|
|
3189
|
+
return __request(OpenAPI, {
|
|
3190
|
+
method: 'GET',
|
|
3191
|
+
url: '/api/v1/{region}/bean/accounts/{accountId}/reconciliations',
|
|
3192
|
+
path: {
|
|
3193
|
+
accountId: data.accountId,
|
|
3194
|
+
region: data.region
|
|
3195
|
+
},
|
|
3196
|
+
errors: {
|
|
3197
|
+
404: 'Account not found'
|
|
3198
|
+
}
|
|
3199
|
+
});
|
|
3200
|
+
}
|
|
3201
|
+
}
|
|
3202
|
+
|
|
2652
3203
|
export class BeanExportService {
|
|
2653
3204
|
/**
|
|
2654
3205
|
* Export Beancount ledger as ZIP
|
|
2655
3206
|
* Export all user Beancount data as a ZIP file containing ledger.beancount and yearly files in community format.
|
|
2656
|
-
* @returns
|
|
3207
|
+
* @returns binary ZIP archive (application/zip) streamed as an attachment
|
|
2657
3208
|
* @throws ApiError
|
|
2658
3209
|
*/
|
|
2659
3210
|
public static exportControllerExportBeancount(): CancelablePromise<ExportControllerExportBeancountResponse> {
|
|
@@ -2818,125 +3369,10 @@ export class BeanImportService {
|
|
|
2818
3369
|
url: '/api/v1/{region}/bean/import/config/{importerId}/reset',
|
|
2819
3370
|
path: {
|
|
2820
3371
|
importerId: data.importerId,
|
|
2821
|
-
region: data.region
|
|
2822
|
-
},
|
|
2823
|
-
errors: {
|
|
2824
|
-
400: 'Invalid input - Unsupported importer'
|
|
2825
|
-
}
|
|
2826
|
-
});
|
|
2827
|
-
}
|
|
2828
|
-
}
|
|
2829
|
-
|
|
2830
|
-
export class BeanPlatformsService {
|
|
2831
|
-
/**
|
|
2832
|
-
* Get all platforms with statistics
|
|
2833
|
-
* @returns unknown List of platforms with binding and account counts
|
|
2834
|
-
* @throws ApiError
|
|
2835
|
-
*/
|
|
2836
|
-
public static platformControllerFindAll(): CancelablePromise<PlatformControllerFindAllResponse> {
|
|
2837
|
-
return __request(OpenAPI, {
|
|
2838
|
-
method: 'GET',
|
|
2839
|
-
url: '/api/v1/bean/platforms'
|
|
2840
|
-
});
|
|
2841
|
-
}
|
|
2842
|
-
|
|
2843
|
-
/**
|
|
2844
|
-
* Create a new platform
|
|
2845
|
-
* @param data The data for the request.
|
|
2846
|
-
* @param data.requestBody
|
|
2847
|
-
* @returns unknown Platform created successfully
|
|
2848
|
-
* @throws ApiError
|
|
2849
|
-
*/
|
|
2850
|
-
public static platformControllerCreate(
|
|
2851
|
-
data: PlatformControllerCreateData
|
|
2852
|
-
): CancelablePromise<PlatformControllerCreateResponse> {
|
|
2853
|
-
return __request(OpenAPI, {
|
|
2854
|
-
method: 'POST',
|
|
2855
|
-
url: '/api/v1/bean/platforms',
|
|
2856
|
-
body: data.requestBody,
|
|
2857
|
-
mediaType: 'application/json',
|
|
2858
|
-
errors: {
|
|
2859
|
-
409: 'Platform already exists'
|
|
2860
|
-
}
|
|
2861
|
-
});
|
|
2862
|
-
}
|
|
2863
|
-
|
|
2864
|
-
/**
|
|
2865
|
-
* Get platform list for current user
|
|
2866
|
-
* @returns unknown List of platforms with user binding status
|
|
2867
|
-
* @throws ApiError
|
|
2868
|
-
*/
|
|
2869
|
-
public static platformControllerGetPlatformList(): CancelablePromise<PlatformControllerGetPlatformListResponse> {
|
|
2870
|
-
return __request(OpenAPI, {
|
|
2871
|
-
method: 'GET',
|
|
2872
|
-
url: '/api/v1/bean/platforms/list'
|
|
2873
|
-
});
|
|
2874
|
-
}
|
|
2875
|
-
|
|
2876
|
-
/**
|
|
2877
|
-
* Match platforms by name or alias
|
|
2878
|
-
* @param data The data for the request.
|
|
2879
|
-
* @param data.q Search query — Chinese name, English name, or abbreviation
|
|
2880
|
-
* @param data.region Region code for category override lookup
|
|
2881
|
-
* @returns unknown List of matching platforms with suggested segment names
|
|
2882
|
-
* @throws ApiError
|
|
2883
|
-
*/
|
|
2884
|
-
public static platformControllerMatchPlatforms(
|
|
2885
|
-
data: PlatformControllerMatchPlatformsData
|
|
2886
|
-
): CancelablePromise<PlatformControllerMatchPlatformsResponse> {
|
|
2887
|
-
return __request(OpenAPI, {
|
|
2888
|
-
method: 'GET',
|
|
2889
|
-
url: '/api/v1/bean/platforms/match',
|
|
2890
|
-
query: {
|
|
2891
|
-
q: data.q,
|
|
2892
|
-
region: data.region
|
|
2893
|
-
}
|
|
2894
|
-
});
|
|
2895
|
-
}
|
|
2896
|
-
|
|
2897
|
-
/**
|
|
2898
|
-
* Update a platform
|
|
2899
|
-
* @param data The data for the request.
|
|
2900
|
-
* @param data.id Platform ID
|
|
2901
|
-
* @param data.requestBody
|
|
2902
|
-
* @returns unknown Platform updated successfully
|
|
2903
|
-
* @throws ApiError
|
|
2904
|
-
*/
|
|
2905
|
-
public static platformControllerUpdate(
|
|
2906
|
-
data: PlatformControllerUpdateData
|
|
2907
|
-
): CancelablePromise<PlatformControllerUpdateResponse> {
|
|
2908
|
-
return __request(OpenAPI, {
|
|
2909
|
-
method: 'PUT',
|
|
2910
|
-
url: '/api/v1/bean/platforms/{id}',
|
|
2911
|
-
path: {
|
|
2912
|
-
id: data.id
|
|
2913
|
-
},
|
|
2914
|
-
body: data.requestBody,
|
|
2915
|
-
mediaType: 'application/json',
|
|
2916
|
-
errors: {
|
|
2917
|
-
404: 'Platform not found'
|
|
2918
|
-
}
|
|
2919
|
-
});
|
|
2920
|
-
}
|
|
2921
|
-
|
|
2922
|
-
/**
|
|
2923
|
-
* Delete a platform
|
|
2924
|
-
* @param data The data for the request.
|
|
2925
|
-
* @param data.id Platform ID
|
|
2926
|
-
* @returns void Platform deleted successfully
|
|
2927
|
-
* @throws ApiError
|
|
2928
|
-
*/
|
|
2929
|
-
public static platformControllerDelete(
|
|
2930
|
-
data: PlatformControllerDeleteData
|
|
2931
|
-
): CancelablePromise<PlatformControllerDeleteResponse> {
|
|
2932
|
-
return __request(OpenAPI, {
|
|
2933
|
-
method: 'DELETE',
|
|
2934
|
-
url: '/api/v1/bean/platforms/{id}',
|
|
2935
|
-
path: {
|
|
2936
|
-
id: data.id
|
|
3372
|
+
region: data.region
|
|
2937
3373
|
},
|
|
2938
3374
|
errors: {
|
|
2939
|
-
|
|
3375
|
+
400: 'Invalid input - Unsupported importer'
|
|
2940
3376
|
}
|
|
2941
3377
|
});
|
|
2942
3378
|
}
|
|
@@ -3042,6 +3478,101 @@ export class ProviderSyncService {
|
|
|
3042
3478
|
}
|
|
3043
3479
|
}
|
|
3044
3480
|
|
|
3481
|
+
export class ExternalAccountLinksService {
|
|
3482
|
+
/**
|
|
3483
|
+
* Create an external account → BeanAccount mapping (ADR-0113)
|
|
3484
|
+
* @param data The data for the request.
|
|
3485
|
+
* @param data.region Region code for tenant context
|
|
3486
|
+
* @param data.requestBody
|
|
3487
|
+
* @returns ExternalAccountLinkResponseDto Link created.
|
|
3488
|
+
* @throws ApiError
|
|
3489
|
+
*/
|
|
3490
|
+
public static externalAccountLinkControllerCreate(
|
|
3491
|
+
data: ExternalAccountLinkControllerCreateData
|
|
3492
|
+
): CancelablePromise<ExternalAccountLinkControllerCreateResponse> {
|
|
3493
|
+
return __request(OpenAPI, {
|
|
3494
|
+
method: 'POST',
|
|
3495
|
+
url: '/api/v1/{region}/bean/external-account-links',
|
|
3496
|
+
path: {
|
|
3497
|
+
region: data.region
|
|
3498
|
+
},
|
|
3499
|
+
body: data.requestBody,
|
|
3500
|
+
mediaType: 'application/json',
|
|
3501
|
+
errors: {
|
|
3502
|
+
422: 'beanAccountId not owned, or an active link already exists.'
|
|
3503
|
+
}
|
|
3504
|
+
});
|
|
3505
|
+
}
|
|
3506
|
+
|
|
3507
|
+
/**
|
|
3508
|
+
* List the user's active external account links
|
|
3509
|
+
* @param data The data for the request.
|
|
3510
|
+
* @param data.provider
|
|
3511
|
+
* @param data.region Region code for tenant context
|
|
3512
|
+
* @returns ExternalAccountLinkListResponseDto Links retrieved.
|
|
3513
|
+
* @throws ApiError
|
|
3514
|
+
*/
|
|
3515
|
+
public static externalAccountLinkControllerFindAll(
|
|
3516
|
+
data: ExternalAccountLinkControllerFindAllData
|
|
3517
|
+
): CancelablePromise<ExternalAccountLinkControllerFindAllResponse> {
|
|
3518
|
+
return __request(OpenAPI, {
|
|
3519
|
+
method: 'GET',
|
|
3520
|
+
url: '/api/v1/{region}/bean/external-account-links',
|
|
3521
|
+
path: {
|
|
3522
|
+
region: data.region
|
|
3523
|
+
},
|
|
3524
|
+
query: {
|
|
3525
|
+
provider: data.provider
|
|
3526
|
+
}
|
|
3527
|
+
});
|
|
3528
|
+
}
|
|
3529
|
+
|
|
3530
|
+
/**
|
|
3531
|
+
* Get a single external account link
|
|
3532
|
+
* @param data The data for the request.
|
|
3533
|
+
* @param data.id
|
|
3534
|
+
* @param data.region Region code for tenant context
|
|
3535
|
+
* @returns ExternalAccountLinkResponseDto Link retrieved.
|
|
3536
|
+
* @throws ApiError
|
|
3537
|
+
*/
|
|
3538
|
+
public static externalAccountLinkControllerFindOne(
|
|
3539
|
+
data: ExternalAccountLinkControllerFindOneData
|
|
3540
|
+
): CancelablePromise<ExternalAccountLinkControllerFindOneResponse> {
|
|
3541
|
+
return __request(OpenAPI, {
|
|
3542
|
+
method: 'GET',
|
|
3543
|
+
url: '/api/v1/{region}/bean/external-account-links/{id}',
|
|
3544
|
+
path: {
|
|
3545
|
+
id: data.id,
|
|
3546
|
+
region: data.region
|
|
3547
|
+
},
|
|
3548
|
+
errors: {
|
|
3549
|
+
422: 'Link not found or not owned by the user.'
|
|
3550
|
+
}
|
|
3551
|
+
});
|
|
3552
|
+
}
|
|
3553
|
+
|
|
3554
|
+
/**
|
|
3555
|
+
* Soft-delete (disconnect) an external account link
|
|
3556
|
+
* @param data The data for the request.
|
|
3557
|
+
* @param data.id
|
|
3558
|
+
* @param data.region Region code for tenant context
|
|
3559
|
+
* @returns void Link soft-deleted; historical transactions are unaffected.
|
|
3560
|
+
* @throws ApiError
|
|
3561
|
+
*/
|
|
3562
|
+
public static externalAccountLinkControllerRemove(
|
|
3563
|
+
data: ExternalAccountLinkControllerRemoveData
|
|
3564
|
+
): CancelablePromise<ExternalAccountLinkControllerRemoveResponse> {
|
|
3565
|
+
return __request(OpenAPI, {
|
|
3566
|
+
method: 'DELETE',
|
|
3567
|
+
url: '/api/v1/{region}/bean/external-account-links/{id}',
|
|
3568
|
+
path: {
|
|
3569
|
+
id: data.id,
|
|
3570
|
+
region: data.region
|
|
3571
|
+
}
|
|
3572
|
+
});
|
|
3573
|
+
}
|
|
3574
|
+
}
|
|
3575
|
+
|
|
3045
3576
|
export class ImportTelemetryService {
|
|
3046
3577
|
/**
|
|
3047
3578
|
* Receive anonymous parser failure telemetry
|
|
@@ -3200,329 +3731,205 @@ export class BeanNlpService {
|
|
|
3200
3731
|
}
|
|
3201
3732
|
}
|
|
3202
3733
|
|
|
3203
|
-
export class
|
|
3734
|
+
export class BeanPlatformsService {
|
|
3204
3735
|
/**
|
|
3205
|
-
* Get
|
|
3206
|
-
*
|
|
3207
|
-
* @param data The data for the request.
|
|
3208
|
-
* @param data.region Region code for tenant context
|
|
3209
|
-
* @param data.date Date for balance calculation (ISO 8601 format)
|
|
3210
|
-
* @returns NetWorthResponseDto Net worth retrieved successfully
|
|
3736
|
+
* Get all platforms with statistics
|
|
3737
|
+
* @returns unknown List of platforms with binding and account counts
|
|
3211
3738
|
* @throws ApiError
|
|
3212
3739
|
*/
|
|
3213
|
-
public static
|
|
3214
|
-
data: DashboardControllerGetNetWorthData
|
|
3215
|
-
): CancelablePromise<DashboardControllerGetNetWorthResponse> {
|
|
3740
|
+
public static platformControllerFindAll(): CancelablePromise<PlatformControllerFindAllResponse> {
|
|
3216
3741
|
return __request(OpenAPI, {
|
|
3217
3742
|
method: 'GET',
|
|
3218
|
-
url: '/api/v1/
|
|
3219
|
-
path: {
|
|
3220
|
-
region: data.region
|
|
3221
|
-
},
|
|
3222
|
-
query: {
|
|
3223
|
-
date: data.date
|
|
3224
|
-
},
|
|
3225
|
-
errors: {
|
|
3226
|
-
401: 'User not authenticated'
|
|
3227
|
-
}
|
|
3743
|
+
url: '/api/v1/bean/platforms'
|
|
3228
3744
|
});
|
|
3229
3745
|
}
|
|
3230
3746
|
|
|
3231
3747
|
/**
|
|
3232
|
-
*
|
|
3233
|
-
* Returns accounts with balances grouped by financial platform
|
|
3748
|
+
* Create a new platform
|
|
3234
3749
|
* @param data The data for the request.
|
|
3235
|
-
* @param data.
|
|
3236
|
-
* @
|
|
3237
|
-
* @param data.date Date for balance calculation (ISO 8601 format)
|
|
3238
|
-
* @param data.accountId Scope to a single account (only valid with groupBy=holdingAssetClass, ADR-0105 §6)
|
|
3239
|
-
* @returns unknown Accounts retrieved successfully. Response type depends on groupBy parameter.
|
|
3750
|
+
* @param data.requestBody
|
|
3751
|
+
* @returns unknown Platform created successfully
|
|
3240
3752
|
* @throws ApiError
|
|
3241
3753
|
*/
|
|
3242
|
-
public static
|
|
3243
|
-
data:
|
|
3244
|
-
): CancelablePromise<
|
|
3754
|
+
public static platformControllerCreate(
|
|
3755
|
+
data: PlatformControllerCreateData
|
|
3756
|
+
): CancelablePromise<PlatformControllerCreateResponse> {
|
|
3245
3757
|
return __request(OpenAPI, {
|
|
3246
|
-
method: '
|
|
3247
|
-
url: '/api/v1/
|
|
3248
|
-
|
|
3249
|
-
|
|
3250
|
-
},
|
|
3251
|
-
query: {
|
|
3252
|
-
groupBy: data.groupBy,
|
|
3253
|
-
date: data.date,
|
|
3254
|
-
accountId: data.accountId
|
|
3255
|
-
},
|
|
3758
|
+
method: 'POST',
|
|
3759
|
+
url: '/api/v1/bean/platforms',
|
|
3760
|
+
body: data.requestBody,
|
|
3761
|
+
mediaType: 'application/json',
|
|
3256
3762
|
errors: {
|
|
3257
|
-
|
|
3763
|
+
409: 'Platform already exists'
|
|
3258
3764
|
}
|
|
3259
3765
|
});
|
|
3260
3766
|
}
|
|
3261
3767
|
|
|
3262
3768
|
/**
|
|
3263
|
-
* Get
|
|
3264
|
-
* Returns income, expenses, and savings for a monthly period
|
|
3769
|
+
* Get platform list for current user
|
|
3265
3770
|
* @param data The data for the request.
|
|
3266
|
-
* @param data.
|
|
3267
|
-
* @
|
|
3268
|
-
* @returns CashFlowResponseDto Cash flow retrieved successfully
|
|
3771
|
+
* @param data.region Region code (ISO 3166-1 alpha-2) that biases within-type-bucket ordering (local-region platforms first). Case-insensitive — stored/compared UPPERCASE ("cn" == "CN").
|
|
3772
|
+
* @returns PlatformListItemDto List of platforms with user binding status
|
|
3269
3773
|
* @throws ApiError
|
|
3270
3774
|
*/
|
|
3271
|
-
public static
|
|
3272
|
-
data:
|
|
3273
|
-
): CancelablePromise<
|
|
3775
|
+
public static platformControllerGetPlatformList(
|
|
3776
|
+
data: PlatformControllerGetPlatformListData = {}
|
|
3777
|
+
): CancelablePromise<PlatformControllerGetPlatformListResponse> {
|
|
3274
3778
|
return __request(OpenAPI, {
|
|
3275
3779
|
method: 'GET',
|
|
3276
|
-
url: '/api/v1/
|
|
3277
|
-
path: {
|
|
3278
|
-
region: data.region
|
|
3279
|
-
},
|
|
3780
|
+
url: '/api/v1/bean/platforms/list',
|
|
3280
3781
|
query: {
|
|
3281
|
-
|
|
3282
|
-
},
|
|
3283
|
-
errors: {
|
|
3284
|
-
400: 'Invalid period format',
|
|
3285
|
-
401: 'User not authenticated'
|
|
3782
|
+
region: data.region
|
|
3286
3783
|
}
|
|
3287
3784
|
});
|
|
3288
3785
|
}
|
|
3289
|
-
}
|
|
3290
3786
|
|
|
3291
|
-
export class InvestmentService {
|
|
3292
3787
|
/**
|
|
3293
|
-
*
|
|
3294
|
-
* Average-cost unrealized P&L per account × commodity, plus cumulative realized P&L on sold lots (method = FIFO | average, default average).
|
|
3788
|
+
* Match platforms by name or alias
|
|
3295
3789
|
* @param data The data for the request.
|
|
3296
|
-
* @param data.
|
|
3297
|
-
* @param data.
|
|
3298
|
-
* @
|
|
3299
|
-
* @param data.method Realized-P&L lot-matching method (default average). Does not affect the average-cost unrealized basis.
|
|
3300
|
-
* @returns HoldingPnlResponseDto Holding P&L retrieved successfully
|
|
3790
|
+
* @param data.q Search query — Chinese name, English name, or abbreviation
|
|
3791
|
+
* @param data.region Region code (ISO 3166-1 alpha-2) that biases within-tier ordering (local-region platforms first); also the intended categoryOverrides key. Case-insensitive — stored/compared UPPERCASE ("cn" == "CN").
|
|
3792
|
+
* @returns PlatformMatchResponseDto Matching platforms with overall match type and truncation flag
|
|
3301
3793
|
* @throws ApiError
|
|
3302
3794
|
*/
|
|
3303
|
-
public static
|
|
3304
|
-
data:
|
|
3305
|
-
): CancelablePromise<
|
|
3795
|
+
public static platformControllerMatchPlatforms(
|
|
3796
|
+
data: PlatformControllerMatchPlatformsData
|
|
3797
|
+
): CancelablePromise<PlatformControllerMatchPlatformsResponse> {
|
|
3306
3798
|
return __request(OpenAPI, {
|
|
3307
3799
|
method: 'GET',
|
|
3308
|
-
url: '/api/v1/
|
|
3309
|
-
path: {
|
|
3310
|
-
region: data.region
|
|
3311
|
-
},
|
|
3800
|
+
url: '/api/v1/bean/platforms/match',
|
|
3312
3801
|
query: {
|
|
3313
|
-
|
|
3314
|
-
accountId: data.accountId,
|
|
3315
|
-
method: data.method
|
|
3316
|
-
},
|
|
3317
|
-
errors: {
|
|
3318
|
-
400: 'Invalid asOf format/value/future date, invalid accountId format, or unsupported method',
|
|
3319
|
-
401: 'User not authenticated'
|
|
3320
|
-
}
|
|
3321
|
-
});
|
|
3322
|
-
}
|
|
3323
|
-
}
|
|
3324
|
-
|
|
3325
|
-
export class BeanPricesService {
|
|
3326
|
-
/**
|
|
3327
|
-
* Create a new price
|
|
3328
|
-
* Creates a new price entry for the authenticated user
|
|
3329
|
-
* @param data The data for the request.
|
|
3330
|
-
* @param data.region Region code for tenant context
|
|
3331
|
-
* @param data.requestBody
|
|
3332
|
-
* @returns PriceResponseDto Price created successfully
|
|
3333
|
-
* @throws ApiError
|
|
3334
|
-
*/
|
|
3335
|
-
public static priceControllerCreate(
|
|
3336
|
-
data: PriceControllerCreateData
|
|
3337
|
-
): CancelablePromise<PriceControllerCreateResponse> {
|
|
3338
|
-
return __request(OpenAPI, {
|
|
3339
|
-
method: 'POST',
|
|
3340
|
-
url: '/api/v1/{region}/bean/prices',
|
|
3341
|
-
path: {
|
|
3802
|
+
q: data.q,
|
|
3342
3803
|
region: data.region
|
|
3343
|
-
},
|
|
3344
|
-
body: data.requestBody,
|
|
3345
|
-
mediaType: 'application/json',
|
|
3346
|
-
errors: {
|
|
3347
|
-
404: 'Currency or quoteCurrency commodity not found',
|
|
3348
|
-
409: 'Price already exists for this currency pair and date'
|
|
3349
3804
|
}
|
|
3350
3805
|
});
|
|
3351
3806
|
}
|
|
3352
3807
|
|
|
3353
3808
|
/**
|
|
3354
|
-
*
|
|
3355
|
-
* Returns all price entries for the authenticated user with optional filtering
|
|
3809
|
+
* Get the region and candidate account standards for a platform
|
|
3356
3810
|
* @param data The data for the request.
|
|
3357
|
-
* @param data.
|
|
3358
|
-
* @param data.
|
|
3359
|
-
* @param data.
|
|
3360
|
-
* @
|
|
3361
|
-
* @param data.dateTo Filter prices to this date (ISO 8601 format)
|
|
3362
|
-
* @param data.search Search term for currency or quoteCurrency (case-insensitive partial match)
|
|
3363
|
-
* @param data.page Page number for pagination (default: 1)
|
|
3364
|
-
* @param data.limit Number of items per page (default: 20, max: 100)
|
|
3365
|
-
* @returns PriceListResponseDto Prices retrieved successfully
|
|
3811
|
+
* @param data.id Platform ID (from a match result)
|
|
3812
|
+
* @param data.region Region code (ISO 3166-1 alpha-2, case-insensitive). Required for global platforms (countryCode null) — resolved as their template region; ignored when the platform has its own countryCode.
|
|
3813
|
+
* @param data.type Filter templates by account type (path first segment)
|
|
3814
|
+
* @returns PlatformStandardsResponseDto Resolved region plus the merged account-standard catalog of that region (groupable by productCategory client-side)
|
|
3366
3815
|
* @throws ApiError
|
|
3367
3816
|
*/
|
|
3368
|
-
public static
|
|
3369
|
-
data:
|
|
3370
|
-
): CancelablePromise<
|
|
3817
|
+
public static platformControllerGetPlatformStandards(
|
|
3818
|
+
data: PlatformControllerGetPlatformStandardsData
|
|
3819
|
+
): CancelablePromise<PlatformControllerGetPlatformStandardsResponse> {
|
|
3371
3820
|
return __request(OpenAPI, {
|
|
3372
3821
|
method: 'GET',
|
|
3373
|
-
url: '/api/v1/{
|
|
3822
|
+
url: '/api/v1/bean/platforms/{id}/standards',
|
|
3374
3823
|
path: {
|
|
3375
|
-
|
|
3824
|
+
id: data.id
|
|
3376
3825
|
},
|
|
3377
3826
|
query: {
|
|
3378
|
-
|
|
3379
|
-
|
|
3380
|
-
dateFrom: data.dateFrom,
|
|
3381
|
-
dateTo: data.dateTo,
|
|
3382
|
-
search: data.search,
|
|
3383
|
-
page: data.page,
|
|
3384
|
-
limit: data.limit
|
|
3385
|
-
}
|
|
3386
|
-
});
|
|
3387
|
-
}
|
|
3388
|
-
|
|
3389
|
-
/**
|
|
3390
|
-
* Get price by ID
|
|
3391
|
-
* Returns a single price entry by its ID
|
|
3392
|
-
* @param data The data for the request.
|
|
3393
|
-
* @param data.id Price ID
|
|
3394
|
-
* @param data.region Region code for tenant context
|
|
3395
|
-
* @returns PriceResponseDto Price retrieved successfully
|
|
3396
|
-
* @throws ApiError
|
|
3397
|
-
*/
|
|
3398
|
-
public static priceControllerFindOne(
|
|
3399
|
-
data: PriceControllerFindOneData
|
|
3400
|
-
): CancelablePromise<PriceControllerFindOneResponse> {
|
|
3401
|
-
return __request(OpenAPI, {
|
|
3402
|
-
method: 'GET',
|
|
3403
|
-
url: '/api/v1/{region}/bean/prices/{id}',
|
|
3404
|
-
path: {
|
|
3405
|
-
id: data.id,
|
|
3406
|
-
region: data.region
|
|
3407
|
-
},
|
|
3408
|
-
errors: {
|
|
3409
|
-
404: 'Price not found'
|
|
3827
|
+
region: data.region,
|
|
3828
|
+
type: data.type
|
|
3410
3829
|
}
|
|
3411
3830
|
});
|
|
3412
3831
|
}
|
|
3413
3832
|
|
|
3414
3833
|
/**
|
|
3415
|
-
* Update a
|
|
3416
|
-
* Updates an existing price entry
|
|
3834
|
+
* Update a platform
|
|
3417
3835
|
* @param data The data for the request.
|
|
3418
|
-
* @param data.id
|
|
3419
|
-
* @param data.region Region code for tenant context
|
|
3836
|
+
* @param data.id Platform ID
|
|
3420
3837
|
* @param data.requestBody
|
|
3421
|
-
* @returns
|
|
3838
|
+
* @returns unknown Platform updated successfully
|
|
3422
3839
|
* @throws ApiError
|
|
3423
3840
|
*/
|
|
3424
|
-
public static
|
|
3425
|
-
data:
|
|
3426
|
-
): CancelablePromise<
|
|
3841
|
+
public static platformControllerUpdate(
|
|
3842
|
+
data: PlatformControllerUpdateData
|
|
3843
|
+
): CancelablePromise<PlatformControllerUpdateResponse> {
|
|
3427
3844
|
return __request(OpenAPI, {
|
|
3428
3845
|
method: 'PUT',
|
|
3429
|
-
url: '/api/v1/
|
|
3846
|
+
url: '/api/v1/bean/platforms/{id}',
|
|
3430
3847
|
path: {
|
|
3431
|
-
id: data.id
|
|
3432
|
-
region: data.region
|
|
3848
|
+
id: data.id
|
|
3433
3849
|
},
|
|
3434
3850
|
body: data.requestBody,
|
|
3435
3851
|
mediaType: 'application/json',
|
|
3436
3852
|
errors: {
|
|
3437
|
-
404: '
|
|
3438
|
-
409: 'Updated price conflicts with existing price'
|
|
3853
|
+
404: 'Platform not found'
|
|
3439
3854
|
}
|
|
3440
3855
|
});
|
|
3441
3856
|
}
|
|
3442
3857
|
|
|
3443
3858
|
/**
|
|
3444
|
-
* Delete a
|
|
3445
|
-
* Deletes a price entry (hard delete)
|
|
3859
|
+
* Delete a platform
|
|
3446
3860
|
* @param data The data for the request.
|
|
3447
|
-
* @param data.id
|
|
3448
|
-
* @
|
|
3449
|
-
* @returns void Price deleted successfully
|
|
3861
|
+
* @param data.id Platform ID
|
|
3862
|
+
* @returns void Platform deleted successfully
|
|
3450
3863
|
* @throws ApiError
|
|
3451
3864
|
*/
|
|
3452
|
-
public static
|
|
3453
|
-
data:
|
|
3454
|
-
): CancelablePromise<
|
|
3865
|
+
public static platformControllerDelete(
|
|
3866
|
+
data: PlatformControllerDeleteData
|
|
3867
|
+
): CancelablePromise<PlatformControllerDeleteResponse> {
|
|
3455
3868
|
return __request(OpenAPI, {
|
|
3456
3869
|
method: 'DELETE',
|
|
3457
|
-
url: '/api/v1/
|
|
3870
|
+
url: '/api/v1/bean/platforms/{id}',
|
|
3458
3871
|
path: {
|
|
3459
|
-
id: data.id
|
|
3460
|
-
region: data.region
|
|
3872
|
+
id: data.id
|
|
3461
3873
|
},
|
|
3462
3874
|
errors: {
|
|
3463
|
-
404: '
|
|
3875
|
+
404: 'Platform not found'
|
|
3464
3876
|
}
|
|
3465
3877
|
});
|
|
3466
3878
|
}
|
|
3879
|
+
}
|
|
3467
3880
|
|
|
3881
|
+
export class DashboardService {
|
|
3468
3882
|
/**
|
|
3469
|
-
*
|
|
3470
|
-
*
|
|
3883
|
+
* Get net worth overview
|
|
3884
|
+
* Returns total net worth with breakdown of assets and liabilities
|
|
3471
3885
|
* @param data The data for the request.
|
|
3472
3886
|
* @param data.region Region code for tenant context
|
|
3473
|
-
* @param data.
|
|
3474
|
-
* @returns
|
|
3887
|
+
* @param data.date Date for balance calculation (ISO 8601 format)
|
|
3888
|
+
* @returns NetWorthResponseDto Net worth retrieved successfully
|
|
3475
3889
|
* @throws ApiError
|
|
3476
3890
|
*/
|
|
3477
|
-
public static
|
|
3478
|
-
data:
|
|
3479
|
-
): CancelablePromise<
|
|
3891
|
+
public static dashboardControllerGetNetWorth(
|
|
3892
|
+
data: DashboardControllerGetNetWorthData
|
|
3893
|
+
): CancelablePromise<DashboardControllerGetNetWorthResponse> {
|
|
3480
3894
|
return __request(OpenAPI, {
|
|
3481
|
-
method: '
|
|
3482
|
-
url: '/api/v1/{region}/
|
|
3895
|
+
method: 'GET',
|
|
3896
|
+
url: '/api/v1/{region}/dashboard/net-worth',
|
|
3483
3897
|
path: {
|
|
3484
3898
|
region: data.region
|
|
3485
3899
|
},
|
|
3486
|
-
|
|
3487
|
-
|
|
3900
|
+
query: {
|
|
3901
|
+
date: data.date
|
|
3902
|
+
},
|
|
3903
|
+
errors: {
|
|
3904
|
+
401: 'User not authenticated'
|
|
3905
|
+
}
|
|
3488
3906
|
});
|
|
3489
3907
|
}
|
|
3490
|
-
}
|
|
3491
3908
|
|
|
3492
|
-
export class ReportingService {
|
|
3493
3909
|
/**
|
|
3494
|
-
* Get
|
|
3495
|
-
*
|
|
3496
|
-
* Returns time series data of portfolio net worth.
|
|
3497
|
-
*
|
|
3498
|
-
* **Multi-currency Support:**
|
|
3499
|
-
* - `series[].byCurrency` - Currency breakdown for each data point
|
|
3500
|
-
* - `byCurrency` - Separate time series grouped by currency
|
|
3501
|
-
* - `warnings` - Exchange rate warnings if conversion failed
|
|
3502
|
-
*
|
|
3503
|
-
* **Parameters:**
|
|
3504
|
-
* - `period`: Time period (1m, 3m, 6m, 1y)
|
|
3505
|
-
* - `granularity`: Data granularity (day, week, month)
|
|
3506
|
-
*
|
|
3910
|
+
* Get accounts grouped by platform
|
|
3911
|
+
* Returns accounts with balances grouped by financial platform
|
|
3507
3912
|
* @param data The data for the request.
|
|
3508
3913
|
* @param data.region Region code for tenant context
|
|
3509
|
-
* @param data.
|
|
3510
|
-
* @param data.
|
|
3511
|
-
* @
|
|
3914
|
+
* @param data.groupBy Grouping strategy
|
|
3915
|
+
* @param data.date Date for balance calculation (ISO 8601 format)
|
|
3916
|
+
* @param data.accountId Scope to a single account (only valid with groupBy=holdingAssetClass, ADR-0105 §6)
|
|
3917
|
+
* @returns unknown Accounts retrieved successfully. Response type depends on groupBy parameter.
|
|
3512
3918
|
* @throws ApiError
|
|
3513
3919
|
*/
|
|
3514
|
-
public static
|
|
3515
|
-
data:
|
|
3516
|
-
): CancelablePromise<
|
|
3920
|
+
public static dashboardControllerGetAccounts(
|
|
3921
|
+
data: DashboardControllerGetAccountsData
|
|
3922
|
+
): CancelablePromise<DashboardControllerGetAccountsResponse> {
|
|
3517
3923
|
return __request(OpenAPI, {
|
|
3518
3924
|
method: 'GET',
|
|
3519
|
-
url: '/api/v1/{region}/
|
|
3925
|
+
url: '/api/v1/{region}/dashboard/accounts',
|
|
3520
3926
|
path: {
|
|
3521
3927
|
region: data.region
|
|
3522
3928
|
},
|
|
3523
3929
|
query: {
|
|
3524
|
-
|
|
3525
|
-
|
|
3930
|
+
groupBy: data.groupBy,
|
|
3931
|
+
date: data.date,
|
|
3932
|
+
accountId: data.accountId
|
|
3526
3933
|
},
|
|
3527
3934
|
errors: {
|
|
3528
3935
|
401: 'User not authenticated'
|
|
@@ -3531,116 +3938,95 @@ export class ReportingService {
|
|
|
3531
3938
|
}
|
|
3532
3939
|
|
|
3533
3940
|
/**
|
|
3534
|
-
* Get cash
|
|
3535
|
-
*
|
|
3536
|
-
* Monthly income / expense / netSavings over a fixed N-month window
|
|
3537
|
-
* (current month + N−1 prior). Missing months are zero-filled (flow metric).
|
|
3538
|
-
*
|
|
3539
|
-
* **Parameters:**
|
|
3540
|
-
* - `period`: 1m | 3m | 6m | 1y (default 6m)
|
|
3541
|
-
* - `granularity`: accepted for API symmetry; v1 returns month buckets
|
|
3542
|
-
*
|
|
3941
|
+
* Get cash flow summary
|
|
3942
|
+
* Returns income, expenses, and savings for a monthly period
|
|
3543
3943
|
* @param data The data for the request.
|
|
3944
|
+
* @param data.period Period in YYYY-MM format
|
|
3544
3945
|
* @param data.region Region code for tenant context
|
|
3545
|
-
* @
|
|
3546
|
-
* @param data.granularity Data granularity (accepted for API symmetry; v1 returns month buckets)
|
|
3547
|
-
* @returns CashFlowTrendsResponseDto Cash-flow trends retrieved successfully
|
|
3946
|
+
* @returns CashFlowResponseDto Cash flow retrieved successfully
|
|
3548
3947
|
* @throws ApiError
|
|
3549
3948
|
*/
|
|
3550
|
-
public static
|
|
3551
|
-
data:
|
|
3552
|
-
): CancelablePromise<
|
|
3949
|
+
public static dashboardControllerGetCashFlow(
|
|
3950
|
+
data: DashboardControllerGetCashFlowData
|
|
3951
|
+
): CancelablePromise<DashboardControllerGetCashFlowResponse> {
|
|
3553
3952
|
return __request(OpenAPI, {
|
|
3554
3953
|
method: 'GET',
|
|
3555
|
-
url: '/api/v1/{region}/
|
|
3954
|
+
url: '/api/v1/{region}/dashboard/cash-flow',
|
|
3556
3955
|
path: {
|
|
3557
3956
|
region: data.region
|
|
3558
3957
|
},
|
|
3559
3958
|
query: {
|
|
3560
|
-
period: data.period
|
|
3561
|
-
granularity: data.granularity
|
|
3959
|
+
period: data.period
|
|
3562
3960
|
},
|
|
3563
3961
|
errors: {
|
|
3962
|
+
400: 'Invalid period format',
|
|
3564
3963
|
401: 'User not authenticated'
|
|
3565
3964
|
}
|
|
3566
3965
|
});
|
|
3567
3966
|
}
|
|
3568
3967
|
|
|
3569
3968
|
/**
|
|
3570
|
-
*
|
|
3571
|
-
*
|
|
3572
|
-
* Manually generate a portfolio snapshot for a specific date.
|
|
3573
|
-
*
|
|
3574
|
-
* **Multi-currency Support:**
|
|
3575
|
-
* - Fetches balances grouped by currency
|
|
3576
|
-
* - Uses user's baseCurrency setting for conversion
|
|
3577
|
-
* - Stores exchange rates and warnings
|
|
3578
|
-
*
|
|
3579
|
-
* **Use Cases:**
|
|
3580
|
-
* - Testing snapshot generation
|
|
3581
|
-
* - Force regeneration after data correction
|
|
3582
|
-
* - Initial setup for new users
|
|
3583
|
-
*
|
|
3969
|
+
* Get expenses/income grouped by functional category
|
|
3970
|
+
* Returns amounts pre-aggregated by functional category (account-path Group segment) with server-side multi-currency conversion. flow=expense (default) aggregates ^Expenses: accounts; flow=income aggregates ^Income: accounts (issue #518)
|
|
3584
3971
|
* @param data The data for the request.
|
|
3585
3972
|
* @param data.region Region code for tenant context
|
|
3586
|
-
* @param data.
|
|
3587
|
-
* @
|
|
3973
|
+
* @param data.groupBy Grouping strategy
|
|
3974
|
+
* @param data.period Time window (1m = current calendar month)
|
|
3975
|
+
* @param data.flow Account root to aggregate (expense → ^Expenses:, income → ^Income:)
|
|
3976
|
+
* @returns ExpensesByCategoryResponseDto Expenses retrieved successfully
|
|
3588
3977
|
* @throws ApiError
|
|
3589
3978
|
*/
|
|
3590
|
-
public static
|
|
3591
|
-
data:
|
|
3592
|
-
): CancelablePromise<
|
|
3979
|
+
public static dashboardControllerGetExpenses(
|
|
3980
|
+
data: DashboardControllerGetExpensesData
|
|
3981
|
+
): CancelablePromise<DashboardControllerGetExpensesResponse> {
|
|
3593
3982
|
return __request(OpenAPI, {
|
|
3594
|
-
method: '
|
|
3595
|
-
url: '/api/v1/{region}/
|
|
3983
|
+
method: 'GET',
|
|
3984
|
+
url: '/api/v1/{region}/dashboard/expenses',
|
|
3596
3985
|
path: {
|
|
3597
3986
|
region: data.region
|
|
3598
3987
|
},
|
|
3599
|
-
|
|
3600
|
-
|
|
3988
|
+
query: {
|
|
3989
|
+
groupBy: data.groupBy,
|
|
3990
|
+
period: data.period,
|
|
3991
|
+
flow: data.flow
|
|
3992
|
+
},
|
|
3601
3993
|
errors: {
|
|
3602
|
-
400: 'Invalid
|
|
3994
|
+
400: 'Invalid groupBy or period',
|
|
3603
3995
|
401: 'User not authenticated'
|
|
3604
3996
|
}
|
|
3605
3997
|
});
|
|
3606
3998
|
}
|
|
3999
|
+
}
|
|
3607
4000
|
|
|
4001
|
+
export class InvestmentService {
|
|
3608
4002
|
/**
|
|
3609
|
-
*
|
|
3610
|
-
*
|
|
3611
|
-
* Generate snapshots for a date range (historical data backfill).
|
|
3612
|
-
*
|
|
3613
|
-
* **Multi-currency Support:**
|
|
3614
|
-
* - Each snapshot includes multi-currency data
|
|
3615
|
-
* - Uses exchange rates available at generation time
|
|
3616
|
-
* - Warnings stored for missing exchange rates
|
|
3617
|
-
*
|
|
3618
|
-
* **Best Practices:**
|
|
3619
|
-
* - Use for initial setup after account configuration
|
|
3620
|
-
* - Run during low-traffic periods for large date ranges
|
|
3621
|
-
* - Existing snapshots are skipped (not regenerated)
|
|
3622
|
-
*
|
|
4003
|
+
* Get per-holding unrealized + realized P&L
|
|
4004
|
+
* Average-cost unrealized P&L per account × commodity, plus cumulative realized P&L on sold lots (method = FIFO | average, default average).
|
|
3623
4005
|
* @param data The data for the request.
|
|
3624
4006
|
* @param data.region Region code for tenant context
|
|
3625
|
-
* @param data.
|
|
3626
|
-
* @
|
|
4007
|
+
* @param data.asOf As-of date (ISO 8601), defaults to today
|
|
4008
|
+
* @param data.accountId Scope to a single account
|
|
4009
|
+
* @param data.method Realized-P&L lot-matching method (default average). Does not affect the average-cost unrealized basis.
|
|
4010
|
+
* @returns HoldingPnlResponseDto Holding P&L retrieved successfully
|
|
3627
4011
|
* @throws ApiError
|
|
3628
4012
|
*/
|
|
3629
|
-
public static
|
|
3630
|
-
data:
|
|
3631
|
-
): CancelablePromise<
|
|
4013
|
+
public static holdingPnlControllerGetHoldingPnl(
|
|
4014
|
+
data: HoldingPnlControllerGetHoldingPnlData
|
|
4015
|
+
): CancelablePromise<HoldingPnlControllerGetHoldingPnlResponse> {
|
|
3632
4016
|
return __request(OpenAPI, {
|
|
3633
|
-
method: '
|
|
3634
|
-
url: '/api/v1/{region}/
|
|
4017
|
+
method: 'GET',
|
|
4018
|
+
url: '/api/v1/{region}/investment/holdings/pnl',
|
|
3635
4019
|
path: {
|
|
3636
4020
|
region: data.region
|
|
3637
4021
|
},
|
|
3638
|
-
|
|
3639
|
-
|
|
4022
|
+
query: {
|
|
4023
|
+
asOf: data.asOf,
|
|
4024
|
+
accountId: data.accountId,
|
|
4025
|
+
method: data.method
|
|
4026
|
+
},
|
|
3640
4027
|
errors: {
|
|
3641
|
-
400: 'Invalid date format or
|
|
3642
|
-
401: 'User not authenticated'
|
|
3643
|
-
409: 'Backfill already in progress for this user'
|
|
4028
|
+
400: 'Invalid asOf format/value/future date, invalid accountId format, or unsupported method',
|
|
4029
|
+
401: 'User not authenticated'
|
|
3644
4030
|
}
|
|
3645
4031
|
});
|
|
3646
4032
|
}
|
|
@@ -3669,7 +4055,7 @@ export class AuthService {
|
|
|
3669
4055
|
* Anonymous login with access token
|
|
3670
4056
|
* @param data The data for the request.
|
|
3671
4057
|
* @param data.requestBody
|
|
3672
|
-
* @returns
|
|
4058
|
+
* @returns AnonymousLoginResponseDto Login successful
|
|
3673
4059
|
* @throws ApiError
|
|
3674
4060
|
*/
|
|
3675
4061
|
public static authControllerAccessTokenLogin(
|
|
@@ -3687,15 +4073,52 @@ export class AuthService {
|
|
|
3687
4073
|
}
|
|
3688
4074
|
}
|
|
3689
4075
|
|
|
3690
|
-
export class
|
|
4076
|
+
export class CommunityService {
|
|
4077
|
+
/**
|
|
4078
|
+
* Relay a sanitized parser-contribution payload
|
|
4079
|
+
* A server-side bot re-sanitizes the payload and opens an issue on the target repository; the issue URL is returned. The payload is never persisted or logged (forward-and-drop).
|
|
4080
|
+
* @param data The data for the request.
|
|
4081
|
+
* @param data.region Region code for tenant context (routing only; the institution region rides in the payload meta)
|
|
4082
|
+
* @param data.requestBody
|
|
4083
|
+
* @returns ParserContributionRelayResponseDto Issue created by the bot
|
|
4084
|
+
* @throws ApiError
|
|
4085
|
+
*/
|
|
4086
|
+
public static parserContributionControllerCreate(
|
|
4087
|
+
data: ParserContributionControllerCreateData
|
|
4088
|
+
): CancelablePromise<ParserContributionControllerCreateResponse> {
|
|
4089
|
+
return __request(OpenAPI, {
|
|
4090
|
+
method: 'POST',
|
|
4091
|
+
url: '/api/v1/{region}/community/parser-contributions',
|
|
4092
|
+
path: {
|
|
4093
|
+
region: data.region
|
|
4094
|
+
},
|
|
4095
|
+
body: data.requestBody,
|
|
4096
|
+
mediaType: 'application/json',
|
|
4097
|
+
errors: {
|
|
4098
|
+
401: 'Unauthorized',
|
|
4099
|
+
422: 'Validation failed (institution slug, empty samples, row/cell size limits)',
|
|
4100
|
+
429: 'Rate limited (5 submissions per user per hour)',
|
|
4101
|
+
501: 'Relay not configured on this deployment — clients fall back to the clipboard flow',
|
|
4102
|
+
502: 'GitHub bot failure (upstream), safe to retry'
|
|
4103
|
+
}
|
|
4104
|
+
});
|
|
4105
|
+
}
|
|
4106
|
+
}
|
|
4107
|
+
|
|
4108
|
+
export class AdminCacheService {
|
|
3691
4109
|
/**
|
|
3692
|
-
*
|
|
4110
|
+
* Flush entire cache (L1 + L2)
|
|
4111
|
+
* Clears ALL cache entries across ALL namespaces and users. Use only for emergency cache corruption recovery, maintenance-window refresh, or development resets.
|
|
4112
|
+
* @returns unknown Cache flushed successfully
|
|
3693
4113
|
* @throws ApiError
|
|
3694
4114
|
*/
|
|
3695
4115
|
public static cacheControllerFlushCache(): CancelablePromise<CacheControllerFlushCacheResponse> {
|
|
3696
4116
|
return __request(OpenAPI, {
|
|
3697
4117
|
method: 'POST',
|
|
3698
|
-
url: '/api/v1/cache/flush'
|
|
4118
|
+
url: '/api/v1/cache/flush',
|
|
4119
|
+
errors: {
|
|
4120
|
+
403: 'Admin access required'
|
|
4121
|
+
}
|
|
3699
4122
|
});
|
|
3700
4123
|
}
|
|
3701
4124
|
}
|
|
@@ -3856,3 +4279,53 @@ export class InfoService {
|
|
|
3856
4279
|
});
|
|
3857
4280
|
}
|
|
3858
4281
|
}
|
|
4282
|
+
|
|
4283
|
+
export class MarketDataService {
|
|
4284
|
+
/**
|
|
4285
|
+
* Search market symbols by name or code
|
|
4286
|
+
* Ranked search over the openbb catalog. Empty `q` returns [].
|
|
4287
|
+
* @param data The data for the request.
|
|
4288
|
+
* @param data.q Search term — matched against symbol and instrument name. Empty string returns [].
|
|
4289
|
+
* @param data.limit Maximum number of results (clamped 1..50)
|
|
4290
|
+
* @param data.exchange Filter by exchange code (e.g. US, HK, SS, SZ)
|
|
4291
|
+
* @param data.assetType Filter by OpenBB asset_type (e.g. stock, etf)
|
|
4292
|
+
* @returns SymbolSearchResultDto Ranked search results
|
|
4293
|
+
* @throws ApiError
|
|
4294
|
+
*/
|
|
4295
|
+
public static symbolControllerSearch(
|
|
4296
|
+
data: SymbolControllerSearchData
|
|
4297
|
+
): CancelablePromise<SymbolControllerSearchResponse> {
|
|
4298
|
+
return __request(OpenAPI, {
|
|
4299
|
+
method: 'GET',
|
|
4300
|
+
url: '/api/v1/market/symbols/search',
|
|
4301
|
+
query: {
|
|
4302
|
+
q: data.q,
|
|
4303
|
+
limit: data.limit,
|
|
4304
|
+
exchange: data.exchange,
|
|
4305
|
+
assetType: data.assetType
|
|
4306
|
+
}
|
|
4307
|
+
});
|
|
4308
|
+
}
|
|
4309
|
+
|
|
4310
|
+
/**
|
|
4311
|
+
* Get a market symbol quote
|
|
4312
|
+
* @param data The data for the request.
|
|
4313
|
+
* @param data.symbol
|
|
4314
|
+
* @returns SymbolQuoteDto Symbol quote
|
|
4315
|
+
* @throws ApiError
|
|
4316
|
+
*/
|
|
4317
|
+
public static symbolControllerGetQuote(
|
|
4318
|
+
data: SymbolControllerGetQuoteData
|
|
4319
|
+
): CancelablePromise<SymbolControllerGetQuoteResponse> {
|
|
4320
|
+
return __request(OpenAPI, {
|
|
4321
|
+
method: 'GET',
|
|
4322
|
+
url: '/api/v1/market/symbols/{symbol}/quote',
|
|
4323
|
+
path: {
|
|
4324
|
+
symbol: data.symbol
|
|
4325
|
+
},
|
|
4326
|
+
errors: {
|
|
4327
|
+
404: 'Symbol not found in the openbb catalog'
|
|
4328
|
+
}
|
|
4329
|
+
});
|
|
4330
|
+
}
|
|
4331
|
+
}
|