@firela/api-types 0.0.0-canary.78c2840b → 0.0.0-canary.7a8f5374
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 +1265 -134
- package/dist/index.d.ts +1265 -134
- package/dist/index.js +4 -2
- package/dist/index.mjs +4 -2
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +1060 -22
- package/src/generated/services.gen.ts +533 -3
- package/src/generated/types.gen.ts +1348 -124
|
@@ -316,6 +316,53 @@ export type RegionsMetadataResponseDto = {
|
|
|
316
316
|
regions: Array<RegionInfoDto>;
|
|
317
317
|
};
|
|
318
318
|
|
|
319
|
+
export type CostSpecDto = {
|
|
320
|
+
/**
|
|
321
|
+
* Cost specification mode (mirrors engine CostSpec)
|
|
322
|
+
*/
|
|
323
|
+
mode: 'per-unit' | 'total' | 'date' | 'label' | 'auto';
|
|
324
|
+
/**
|
|
325
|
+
* Per-unit cost (required when mode is "per-unit")
|
|
326
|
+
*/
|
|
327
|
+
numberPerUnit?: string;
|
|
328
|
+
/**
|
|
329
|
+
* Total cost for all units (required when mode is "total")
|
|
330
|
+
*/
|
|
331
|
+
totalNumber?: string;
|
|
332
|
+
/**
|
|
333
|
+
* Cost currency (required in all modes)
|
|
334
|
+
*/
|
|
335
|
+
currency: string;
|
|
336
|
+
/**
|
|
337
|
+
* Lot acquisition date, ISO 8601 (required when mode is "date")
|
|
338
|
+
*/
|
|
339
|
+
date?: string;
|
|
340
|
+
/**
|
|
341
|
+
* Lot label (required when mode is "label"; optional tag in buy modes)
|
|
342
|
+
*/
|
|
343
|
+
label?: string;
|
|
344
|
+
/**
|
|
345
|
+
* Merge lots for AVERAGE booking (mode: auto)
|
|
346
|
+
*/
|
|
347
|
+
merge?: boolean;
|
|
348
|
+
};
|
|
349
|
+
|
|
350
|
+
/**
|
|
351
|
+
* Cost specification mode (mirrors engine CostSpec)
|
|
352
|
+
*/
|
|
353
|
+
export type mode = 'per-unit' | 'total' | 'date' | 'label' | 'auto';
|
|
354
|
+
|
|
355
|
+
export type AmountDto = {
|
|
356
|
+
/**
|
|
357
|
+
* Amount as decimal string (max 15 integer + 15 decimal digits)
|
|
358
|
+
*/
|
|
359
|
+
number: string;
|
|
360
|
+
/**
|
|
361
|
+
* Currency/commodity code
|
|
362
|
+
*/
|
|
363
|
+
currency: string;
|
|
364
|
+
};
|
|
365
|
+
|
|
319
366
|
export type CreatePostingDto = {
|
|
320
367
|
/**
|
|
321
368
|
* Account name in Beancount format (must start with uppercase, colon-separated)
|
|
@@ -335,6 +382,14 @@ export type CreatePostingDto = {
|
|
|
335
382
|
meta?: {
|
|
336
383
|
[key: string]: unknown;
|
|
337
384
|
};
|
|
385
|
+
/**
|
|
386
|
+
* Cost basis (Beancount `{...}`). Maps to engine costSpec. Required for commodity holdings so they carry a monetary weight that can balance.
|
|
387
|
+
*/
|
|
388
|
+
cost?: CostSpecDto;
|
|
389
|
+
/**
|
|
390
|
+
* Price annotation (Beancount `@...`). Maps to engine price. Used for valuation; cost takes priority for balance weight.
|
|
391
|
+
*/
|
|
392
|
+
price?: AmountDto;
|
|
338
393
|
};
|
|
339
394
|
|
|
340
395
|
export type CreateTransactionDto = {
|
|
@@ -387,6 +442,25 @@ export type CreateTransactionDto = {
|
|
|
387
442
|
*/
|
|
388
443
|
export type flag = '*' | '!';
|
|
389
444
|
|
|
445
|
+
export type CostDetailDto = {
|
|
446
|
+
/**
|
|
447
|
+
* Per-unit cost basis (mirrors engine Cost.number)
|
|
448
|
+
*/
|
|
449
|
+
number?: string;
|
|
450
|
+
/**
|
|
451
|
+
* Cost currency
|
|
452
|
+
*/
|
|
453
|
+
currency?: string;
|
|
454
|
+
/**
|
|
455
|
+
* Lot acquisition date (ISO yyyy-mm-dd)
|
|
456
|
+
*/
|
|
457
|
+
date?: string;
|
|
458
|
+
/**
|
|
459
|
+
* Lot label
|
|
460
|
+
*/
|
|
461
|
+
label?: string;
|
|
462
|
+
};
|
|
463
|
+
|
|
390
464
|
export type PostingResponseDto = {
|
|
391
465
|
/**
|
|
392
466
|
* Account name
|
|
@@ -400,6 +474,10 @@ export type PostingResponseDto = {
|
|
|
400
474
|
* Currency
|
|
401
475
|
*/
|
|
402
476
|
currency?: string;
|
|
477
|
+
/**
|
|
478
|
+
* Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.
|
|
479
|
+
*/
|
|
480
|
+
cost?: CostDetailDto;
|
|
403
481
|
};
|
|
404
482
|
|
|
405
483
|
export type RecurringSuggestionDto = {
|
|
@@ -620,9 +698,9 @@ export type PostingDetailDto = {
|
|
|
620
698
|
*/
|
|
621
699
|
accountId: string;
|
|
622
700
|
/**
|
|
623
|
-
*
|
|
701
|
+
* Fully-qualified Beancount account path
|
|
624
702
|
*/
|
|
625
|
-
|
|
703
|
+
account: string;
|
|
626
704
|
/**
|
|
627
705
|
* Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.
|
|
628
706
|
*/
|
|
@@ -643,6 +721,10 @@ export type PostingDetailDto = {
|
|
|
643
721
|
* Cost date
|
|
644
722
|
*/
|
|
645
723
|
costDate?: string;
|
|
724
|
+
/**
|
|
725
|
+
* Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.
|
|
726
|
+
*/
|
|
727
|
+
cost?: CostDetailDto;
|
|
646
728
|
/**
|
|
647
729
|
* Price amount
|
|
648
730
|
*/
|
|
@@ -1242,17 +1324,17 @@ export type ResolveResultDto = {
|
|
|
1242
1324
|
[key: string]: string;
|
|
1243
1325
|
};
|
|
1244
1326
|
/**
|
|
1245
|
-
* Resolution ID for undo
|
|
1327
|
+
* Resolution ID for undo. Absent when the resolver rejected the decision (review stayed PENDING).
|
|
1246
1328
|
*/
|
|
1247
|
-
resolutionId
|
|
1329
|
+
resolutionId?: string;
|
|
1248
1330
|
/**
|
|
1249
1331
|
* Whether this decision can be undone
|
|
1250
1332
|
*/
|
|
1251
|
-
canUndo
|
|
1333
|
+
canUndo?: boolean;
|
|
1252
1334
|
/**
|
|
1253
1335
|
* Deadline for undo (24h from resolution)
|
|
1254
1336
|
*/
|
|
1255
|
-
undoDeadline
|
|
1337
|
+
undoDeadline?: string;
|
|
1256
1338
|
/**
|
|
1257
1339
|
* Rule ID if learning was triggered (ACCEPT_AND_LEARN actions). Use this to deep-link to the rule management page.
|
|
1258
1340
|
*/
|
|
@@ -2947,6 +3029,96 @@ export type UpdatePropertyDto = {
|
|
|
2947
3029
|
value: string;
|
|
2948
3030
|
};
|
|
2949
3031
|
|
|
3032
|
+
export type CreateBeanEventDto = {
|
|
3033
|
+
/**
|
|
3034
|
+
* Life event date (ISO 8601)
|
|
3035
|
+
*/
|
|
3036
|
+
date: string;
|
|
3037
|
+
/**
|
|
3038
|
+
* Life event type (e.g., "employer", "location", "marital-status") — user-defined, no enum constraint at engine layer
|
|
3039
|
+
*/
|
|
3040
|
+
type: string;
|
|
3041
|
+
/**
|
|
3042
|
+
* Life event description. Empty string is a VALID value (distinct from absence).
|
|
3043
|
+
*/
|
|
3044
|
+
description: string;
|
|
3045
|
+
/**
|
|
3046
|
+
* Product-side metadata (lives in BeanEvent.meta JSON, never in engine Event fields)
|
|
3047
|
+
*/
|
|
3048
|
+
meta?: {
|
|
3049
|
+
[key: string]: unknown;
|
|
3050
|
+
};
|
|
3051
|
+
};
|
|
3052
|
+
|
|
3053
|
+
export type EventResponseDto = {
|
|
3054
|
+
/**
|
|
3055
|
+
* Unique identifier
|
|
3056
|
+
*/
|
|
3057
|
+
id: string;
|
|
3058
|
+
/**
|
|
3059
|
+
* User ID (owner of the life event)
|
|
3060
|
+
*/
|
|
3061
|
+
userId: string;
|
|
3062
|
+
/**
|
|
3063
|
+
* Life event date (ISO 8601 format)
|
|
3064
|
+
*/
|
|
3065
|
+
date: string;
|
|
3066
|
+
/**
|
|
3067
|
+
* Life event type (user-defined, e.g., "employer", "location")
|
|
3068
|
+
*/
|
|
3069
|
+
type: string;
|
|
3070
|
+
/**
|
|
3071
|
+
* Life event description. May be an empty string (a valid value distinct from absence).
|
|
3072
|
+
*/
|
|
3073
|
+
description: string;
|
|
3074
|
+
/**
|
|
3075
|
+
* Product-side metadata (free-form JSON)
|
|
3076
|
+
*/
|
|
3077
|
+
meta: {
|
|
3078
|
+
[key: string]: unknown;
|
|
3079
|
+
};
|
|
3080
|
+
/**
|
|
3081
|
+
* Creation timestamp
|
|
3082
|
+
*/
|
|
3083
|
+
createdAt: string;
|
|
3084
|
+
/**
|
|
3085
|
+
* Last update timestamp. Also emitted as the ETag response header for If-Match optimistic concurrency.
|
|
3086
|
+
*/
|
|
3087
|
+
updatedAt: string;
|
|
3088
|
+
};
|
|
3089
|
+
|
|
3090
|
+
export type EventListResponseDto = {
|
|
3091
|
+
/**
|
|
3092
|
+
* List of life events
|
|
3093
|
+
*/
|
|
3094
|
+
items: Array<EventResponseDto>;
|
|
3095
|
+
/**
|
|
3096
|
+
* Total number of life events matching the query
|
|
3097
|
+
*/
|
|
3098
|
+
total: number;
|
|
3099
|
+
};
|
|
3100
|
+
|
|
3101
|
+
export type UpdateBeanEventDto = {
|
|
3102
|
+
/**
|
|
3103
|
+
* Life event date (ISO 8601)
|
|
3104
|
+
*/
|
|
3105
|
+
date?: string;
|
|
3106
|
+
/**
|
|
3107
|
+
* Life event type (user-defined)
|
|
3108
|
+
*/
|
|
3109
|
+
type?: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* Life event description. Empty string is a VALID value (distinct from absence).
|
|
3112
|
+
*/
|
|
3113
|
+
description?: string;
|
|
3114
|
+
/**
|
|
3115
|
+
* Product-side metadata (free-form JSON)
|
|
3116
|
+
*/
|
|
3117
|
+
meta?: {
|
|
3118
|
+
[key: string]: unknown;
|
|
3119
|
+
};
|
|
3120
|
+
};
|
|
3121
|
+
|
|
2950
3122
|
export type FileImportDto = {
|
|
2951
3123
|
/**
|
|
2952
3124
|
* Bill file to import (CSV, PDF, OFX, etc.)
|
|
@@ -3411,6 +3583,8 @@ export type SupportedProvidersResponseDto = {
|
|
|
3411
3583
|
|
|
3412
3584
|
export type ParserTelemetryReportDto = unknown;
|
|
3413
3585
|
|
|
3586
|
+
export type UncoveredFormatMissDto = unknown;
|
|
3587
|
+
|
|
3414
3588
|
export type ProcessNlpDto = {
|
|
3415
3589
|
/**
|
|
3416
3590
|
* Natural language text describing a transaction (Chinese)
|
|
@@ -4196,8 +4370,21 @@ export type AccountItemWithAssetClassDto = {
|
|
|
4196
4370
|
* Risk level
|
|
4197
4371
|
*/
|
|
4198
4372
|
riskLevel?: string;
|
|
4373
|
+
/**
|
|
4374
|
+
* ADR-0105 classification provenance (holding level always; account level only on FALLBACK)
|
|
4375
|
+
*/
|
|
4376
|
+
source?: 'USER_META' | 'FIAT_CURRENCY' | 'OPENBB_MAPPING' | 'FALLBACK';
|
|
4199
4377
|
};
|
|
4200
4378
|
|
|
4379
|
+
/**
|
|
4380
|
+
* ADR-0105 classification provenance (holding level always; account level only on FALLBACK)
|
|
4381
|
+
*/
|
|
4382
|
+
export type source2 =
|
|
4383
|
+
| 'USER_META'
|
|
4384
|
+
| 'FIAT_CURRENCY'
|
|
4385
|
+
| 'OPENBB_MAPPING'
|
|
4386
|
+
| 'FALLBACK';
|
|
4387
|
+
|
|
4201
4388
|
export type AssetClassGroupDto = {
|
|
4202
4389
|
/**
|
|
4203
4390
|
* Asset class name
|
|
@@ -4284,6 +4471,12 @@ export type AssetClassSummaryDto = {
|
|
|
4284
4471
|
* Exchange rate warnings
|
|
4285
4472
|
*/
|
|
4286
4473
|
warnings?: Array<AccountExchangeRateWarningDto>;
|
|
4474
|
+
/**
|
|
4475
|
+
* ADR-0105 §4 fallback provenance stats (holding level only). valueRatio is the grey-area share of total converted value; count is the number of source=FALLBACK holdings.
|
|
4476
|
+
*/
|
|
4477
|
+
fallback?: {
|
|
4478
|
+
[key: string]: unknown;
|
|
4479
|
+
};
|
|
4287
4480
|
};
|
|
4288
4481
|
|
|
4289
4482
|
export type AssetClassAccountsResponseDto = {
|
|
@@ -4295,6 +4488,56 @@ export type AssetClassAccountsResponseDto = {
|
|
|
4295
4488
|
* Summary statistics
|
|
4296
4489
|
*/
|
|
4297
4490
|
summary: AssetClassSummaryDto;
|
|
4491
|
+
/**
|
|
4492
|
+
* ADR-0105 §6 holding-level grey-area bucket (source=FALLBACK holdings peeled out of groups). Present only for groupBy=holdingAssetClass when FALLBACK holdings exist.
|
|
4493
|
+
*/
|
|
4494
|
+
uncategorized?: AssetClassGroupDto;
|
|
4495
|
+
};
|
|
4496
|
+
|
|
4497
|
+
export type HoldingAssetClassAccountSliceDto = {
|
|
4498
|
+
/**
|
|
4499
|
+
* Account ID
|
|
4500
|
+
*/
|
|
4501
|
+
accountId: string;
|
|
4502
|
+
/**
|
|
4503
|
+
* Full account path
|
|
4504
|
+
*/
|
|
4505
|
+
accountPath: string;
|
|
4506
|
+
/**
|
|
4507
|
+
* Currency of the holding with the largest converted base value; undefined when no holding is convertible
|
|
4508
|
+
*/
|
|
4509
|
+
accountCurrency?: string;
|
|
4510
|
+
/**
|
|
4511
|
+
* Account's market value in base currency (Σ converted holdings; grey bucket included)
|
|
4512
|
+
*/
|
|
4513
|
+
marketValueBase: string;
|
|
4514
|
+
/**
|
|
4515
|
+
* Share of the global total (0-100). 0 when globalTotal is zero (no NaN/Infinity).
|
|
4516
|
+
*/
|
|
4517
|
+
shareOfTotalPct: number;
|
|
4518
|
+
/**
|
|
4519
|
+
* Per-account asset-class breakdown
|
|
4520
|
+
*/
|
|
4521
|
+
groups: Array<AssetClassGroupDto>;
|
|
4522
|
+
/**
|
|
4523
|
+
* Per-account grey bucket (source=FALLBACK holdings, incl. broker cash)
|
|
4524
|
+
*/
|
|
4525
|
+
uncategorized?: AssetClassGroupDto;
|
|
4526
|
+
/**
|
|
4527
|
+
* Every holding row for this account (account ID in each row’s `id` field)
|
|
4528
|
+
*/
|
|
4529
|
+
holdings: Array<AccountItemWithAssetClassDto>;
|
|
4530
|
+
};
|
|
4531
|
+
|
|
4532
|
+
export type HoldingAssetClassCrossAccountResponseDto = {
|
|
4533
|
+
/**
|
|
4534
|
+
* Merged cross-account holding aggregation
|
|
4535
|
+
*/
|
|
4536
|
+
global: AssetClassAccountsResponseDto;
|
|
4537
|
+
/**
|
|
4538
|
+
* Per-account slices
|
|
4539
|
+
*/
|
|
4540
|
+
byAccount: Array<HoldingAssetClassAccountSliceDto>;
|
|
4298
4541
|
};
|
|
4299
4542
|
|
|
4300
4543
|
export type CashFlowByCurrencyDto = {
|
|
@@ -4376,135 +4619,562 @@ export type CashFlowResponseDto = {
|
|
|
4376
4619
|
warnings?: Array<ExchangeRateWarningDto>;
|
|
4377
4620
|
};
|
|
4378
4621
|
|
|
4379
|
-
export type
|
|
4380
|
-
/**
|
|
4381
|
-
* ISO 4217 currency code
|
|
4382
|
-
*/
|
|
4383
|
-
currency: string;
|
|
4622
|
+
export type CategoryGroupDto = {
|
|
4384
4623
|
/**
|
|
4385
|
-
*
|
|
4624
|
+
* Functional category (account-path Group segment); regional and universal account paths merge under it
|
|
4386
4625
|
*/
|
|
4387
|
-
|
|
4388
|
-
};
|
|
4389
|
-
|
|
4390
|
-
export type TimeSeriesPointDto = {
|
|
4626
|
+
category: string;
|
|
4391
4627
|
/**
|
|
4392
|
-
*
|
|
4628
|
+
* Converted total for this category in base currency (expense amount when flow=expense, income amount when flow=income)
|
|
4393
4629
|
*/
|
|
4394
|
-
|
|
4630
|
+
totalExpense: string;
|
|
4395
4631
|
/**
|
|
4396
|
-
*
|
|
4632
|
+
* Share of grand total (0-100); 0 when grand total is 0
|
|
4397
4633
|
*/
|
|
4398
|
-
|
|
4634
|
+
sharePct: number;
|
|
4399
4635
|
/**
|
|
4400
|
-
*
|
|
4636
|
+
* Raw (unconverted) expense per currency
|
|
4401
4637
|
*/
|
|
4402
|
-
|
|
4403
|
-
[key: string]: unknown;
|
|
4404
|
-
};
|
|
4638
|
+
balanceByCurrency: Array<BalanceByCurrencyDto>;
|
|
4405
4639
|
/**
|
|
4406
|
-
*
|
|
4640
|
+
* Converted total in base currency (omitted when FX missing for all currencies in this category)
|
|
4407
4641
|
*/
|
|
4408
|
-
|
|
4642
|
+
convertedBalance?: string;
|
|
4409
4643
|
};
|
|
4410
4644
|
|
|
4411
|
-
export type
|
|
4645
|
+
export type ExpensesByCategorySummaryDto = {
|
|
4412
4646
|
/**
|
|
4413
|
-
*
|
|
4647
|
+
* Total across all categories, converted (convertible categories only); expense totals when flow=expense, income totals when flow=income
|
|
4414
4648
|
*/
|
|
4415
|
-
|
|
4649
|
+
totalExpense: string;
|
|
4416
4650
|
/**
|
|
4417
|
-
*
|
|
4651
|
+
* Number of categories
|
|
4418
4652
|
*/
|
|
4419
|
-
|
|
4653
|
+
categoryCount: number;
|
|
4654
|
+
};
|
|
4655
|
+
|
|
4656
|
+
export type ExpensesByCategoryResponseDto = {
|
|
4420
4657
|
/**
|
|
4421
|
-
*
|
|
4658
|
+
* Period requested
|
|
4422
4659
|
*/
|
|
4423
|
-
|
|
4660
|
+
period: string;
|
|
4424
4661
|
/**
|
|
4425
|
-
*
|
|
4662
|
+
* Base currency for converted values
|
|
4426
4663
|
*/
|
|
4427
|
-
|
|
4428
|
-
};
|
|
4429
|
-
|
|
4430
|
-
export type MultiCurrencyPointDto = {
|
|
4664
|
+
baseCurrency: string;
|
|
4431
4665
|
/**
|
|
4432
|
-
*
|
|
4666
|
+
* Expense groups by functional category, sorted by converted total desc
|
|
4433
4667
|
*/
|
|
4434
|
-
|
|
4668
|
+
groups: Array<CategoryGroupDto>;
|
|
4435
4669
|
/**
|
|
4436
|
-
*
|
|
4670
|
+
* Summary statistics
|
|
4437
4671
|
*/
|
|
4438
|
-
|
|
4672
|
+
summary: ExpensesByCategorySummaryDto;
|
|
4673
|
+
/**
|
|
4674
|
+
* Exchange rate warnings (e.g. missing rate for a currency)
|
|
4675
|
+
*/
|
|
4676
|
+
warnings?: Array<ExchangeRateWarningDto>;
|
|
4439
4677
|
};
|
|
4440
4678
|
|
|
4441
|
-
export type
|
|
4679
|
+
export type MonetaryDto = {
|
|
4442
4680
|
/**
|
|
4443
|
-
*
|
|
4681
|
+
* Amount (Decimal string)
|
|
4444
4682
|
*/
|
|
4445
|
-
|
|
4683
|
+
amount: string;
|
|
4446
4684
|
/**
|
|
4447
|
-
*
|
|
4685
|
+
* ISO 4217 currency
|
|
4448
4686
|
*/
|
|
4449
|
-
|
|
4687
|
+
currency: string;
|
|
4450
4688
|
/**
|
|
4451
|
-
*
|
|
4689
|
+
* Converted to user base currency (Decimal string)
|
|
4452
4690
|
*/
|
|
4453
|
-
|
|
4691
|
+
baseCcyEquivalent?: {
|
|
4692
|
+
[key: string]: unknown;
|
|
4693
|
+
} | null;
|
|
4694
|
+
};
|
|
4695
|
+
|
|
4696
|
+
export type CurrentPriceDto = {
|
|
4454
4697
|
/**
|
|
4455
|
-
*
|
|
4698
|
+
* Price amount (Decimal string)
|
|
4456
4699
|
*/
|
|
4457
|
-
|
|
4700
|
+
amount: string;
|
|
4458
4701
|
/**
|
|
4459
|
-
*
|
|
4702
|
+
* Price currency (ISO 4217)
|
|
4460
4703
|
*/
|
|
4461
4704
|
currency: string;
|
|
4462
4705
|
/**
|
|
4463
|
-
*
|
|
4706
|
+
* Price date (ISO 8601)
|
|
4464
4707
|
*/
|
|
4465
|
-
|
|
4708
|
+
date: string;
|
|
4466
4709
|
/**
|
|
4467
|
-
*
|
|
4710
|
+
* Price source
|
|
4468
4711
|
*/
|
|
4469
|
-
|
|
4712
|
+
source: 'USER_OVERRIDE' | 'OPENBB_EQUITY' | 'OPENBB_CURRENCY';
|
|
4470
4713
|
};
|
|
4471
4714
|
|
|
4472
|
-
|
|
4473
|
-
|
|
4474
|
-
|
|
4475
|
-
|
|
4476
|
-
export type BackfillSnapshotsBody = unknown;
|
|
4477
|
-
|
|
4478
|
-
export type BackfillSnapshotsResponse = unknown;
|
|
4715
|
+
/**
|
|
4716
|
+
* Price source
|
|
4717
|
+
*/
|
|
4718
|
+
export type source3 = 'USER_OVERRIDE' | 'OPENBB_EQUITY' | 'OPENBB_CURRENCY';
|
|
4479
4719
|
|
|
4480
|
-
export type
|
|
4720
|
+
export type FxRateDto = {
|
|
4721
|
+
from: string;
|
|
4722
|
+
to: string;
|
|
4481
4723
|
/**
|
|
4482
|
-
*
|
|
4724
|
+
* FX rate (Decimal string)
|
|
4483
4725
|
*/
|
|
4484
|
-
|
|
4485
|
-
};
|
|
4486
|
-
|
|
4487
|
-
export type AccountControllerCreateData = {
|
|
4726
|
+
rate: string;
|
|
4488
4727
|
/**
|
|
4489
|
-
*
|
|
4728
|
+
* Rate date (ISO 8601)
|
|
4490
4729
|
*/
|
|
4491
|
-
|
|
4492
|
-
requestBody: CreateAccountDto;
|
|
4730
|
+
date: string;
|
|
4493
4731
|
};
|
|
4494
4732
|
|
|
4495
|
-
export type
|
|
4496
|
-
|
|
4497
|
-
export type AccountControllerFindAllData = {
|
|
4733
|
+
export type HoldingPnlRowDto = {
|
|
4498
4734
|
/**
|
|
4499
|
-
*
|
|
4735
|
+
* Account UUID
|
|
4500
4736
|
*/
|
|
4501
|
-
|
|
4737
|
+
accountId: string;
|
|
4502
4738
|
/**
|
|
4503
|
-
*
|
|
4739
|
+
* Full account path
|
|
4504
4740
|
*/
|
|
4505
|
-
|
|
4741
|
+
accountPath: string;
|
|
4506
4742
|
/**
|
|
4507
|
-
*
|
|
4743
|
+
* Account settlement currency (ISO 4217), from cost currency
|
|
4744
|
+
*/
|
|
4745
|
+
accountCcy?: {
|
|
4746
|
+
[key: string]: unknown;
|
|
4747
|
+
} | null;
|
|
4748
|
+
/**
|
|
4749
|
+
* Broker type derived from Platform.type
|
|
4750
|
+
*/
|
|
4751
|
+
brokerType?: {
|
|
4752
|
+
[key: string]: unknown;
|
|
4753
|
+
} | null;
|
|
4754
|
+
/**
|
|
4755
|
+
* Commodity symbol
|
|
4756
|
+
*/
|
|
4757
|
+
symbol: string;
|
|
4758
|
+
/**
|
|
4759
|
+
* Chart segment token (libs/common resolver)
|
|
4760
|
+
*/
|
|
4761
|
+
chartToken: 'equity' | 'fund' | 'bond' | 'cash' | 'other';
|
|
4762
|
+
assetClass: string;
|
|
4763
|
+
assetSubClass?: {
|
|
4764
|
+
[key: string]: unknown;
|
|
4765
|
+
} | null;
|
|
4766
|
+
/**
|
|
4767
|
+
* Net held units (Decimal string)
|
|
4768
|
+
*/
|
|
4769
|
+
units: string;
|
|
4770
|
+
/**
|
|
4771
|
+
* Average cost per unit; null when cost currency conflicts or no cost
|
|
4772
|
+
*/
|
|
4773
|
+
averageCostPerUnit?: MonetaryDto | null;
|
|
4774
|
+
/**
|
|
4775
|
+
* Cost basis of held units
|
|
4776
|
+
*/
|
|
4777
|
+
costBasis?: MonetaryDto | null;
|
|
4778
|
+
/**
|
|
4779
|
+
* Market value at asOf price
|
|
4780
|
+
*/
|
|
4781
|
+
marketValue?: MonetaryDto | null;
|
|
4782
|
+
/**
|
|
4783
|
+
* Price used for market value
|
|
4784
|
+
*/
|
|
4785
|
+
currentPrice?: CurrentPriceDto | null;
|
|
4786
|
+
/**
|
|
4787
|
+
* Unrealized P&L in base currency (Decimal string); null when any FX/price missing
|
|
4788
|
+
*/
|
|
4789
|
+
unrealizedPnlBase?: {
|
|
4790
|
+
[key: string]: unknown;
|
|
4791
|
+
} | null;
|
|
4792
|
+
/**
|
|
4793
|
+
* Unrealized P&L % (Decimal string)
|
|
4794
|
+
*/
|
|
4795
|
+
unrealizedPnlPct?: {
|
|
4796
|
+
[key: string]: unknown;
|
|
4797
|
+
} | null;
|
|
4798
|
+
/**
|
|
4799
|
+
* Historical FX rate applied to cost basis
|
|
4800
|
+
*/
|
|
4801
|
+
costFxRate?: FxRateDto | null;
|
|
4802
|
+
/**
|
|
4803
|
+
* FX rate applied to market value
|
|
4804
|
+
*/
|
|
4805
|
+
marketFxRate?: FxRateDto | null;
|
|
4806
|
+
/**
|
|
4807
|
+
* Share of invested assets % (Decimal string); only for invested chartTokens
|
|
4808
|
+
*/
|
|
4809
|
+
pctOfInvestedAssets?: {
|
|
4810
|
+
[key: string]: unknown;
|
|
4811
|
+
} | null;
|
|
4812
|
+
/**
|
|
4813
|
+
* Cumulative realized P&L on sold lots (asOf-date cutoff); null when the method has no applicable sells, a sell lacks a price, or any required FX rate is missing (never-mix). When a sell spans multiple currencies (cross-currency sale), amount and currency reflect the base currency; baseCcyEquivalent is always the authoritative dual-FX figure
|
|
4814
|
+
*/
|
|
4815
|
+
realizedPnl?: MonetaryDto | null;
|
|
4816
|
+
};
|
|
4817
|
+
|
|
4818
|
+
/**
|
|
4819
|
+
* Chart segment token (libs/common resolver)
|
|
4820
|
+
*/
|
|
4821
|
+
export type chartToken = 'equity' | 'fund' | 'bond' | 'cash' | 'other';
|
|
4822
|
+
|
|
4823
|
+
export type HoldingPnlWarningDto = {
|
|
4824
|
+
/**
|
|
4825
|
+
* Warning type
|
|
4826
|
+
*/
|
|
4827
|
+
type:
|
|
4828
|
+
| 'MISSING_COST_FX_RATE'
|
|
4829
|
+
| 'MISSING_MARKET_FX_RATE'
|
|
4830
|
+
| 'MISSING_SALE_PRICE'
|
|
4831
|
+
| 'MISSING_REALIZED_FX_RATE'
|
|
4832
|
+
| 'OVERSOLD_LOTS'
|
|
4833
|
+
| 'NO_PRICE'
|
|
4834
|
+
| 'MIXED_COST_CURRENCY';
|
|
4835
|
+
symbol?: {
|
|
4836
|
+
[key: string]: unknown;
|
|
4837
|
+
} | null;
|
|
4838
|
+
accountId?: {
|
|
4839
|
+
[key: string]: unknown;
|
|
4840
|
+
} | null;
|
|
4841
|
+
currency?: {
|
|
4842
|
+
[key: string]: unknown;
|
|
4843
|
+
} | null;
|
|
4844
|
+
};
|
|
4845
|
+
|
|
4846
|
+
/**
|
|
4847
|
+
* Warning type
|
|
4848
|
+
*/
|
|
4849
|
+
export type type4 =
|
|
4850
|
+
| 'MISSING_COST_FX_RATE'
|
|
4851
|
+
| 'MISSING_MARKET_FX_RATE'
|
|
4852
|
+
| 'MISSING_SALE_PRICE'
|
|
4853
|
+
| 'MISSING_REALIZED_FX_RATE'
|
|
4854
|
+
| 'OVERSOLD_LOTS'
|
|
4855
|
+
| 'NO_PRICE'
|
|
4856
|
+
| 'MIXED_COST_CURRENCY';
|
|
4857
|
+
|
|
4858
|
+
export type HoldingPnlResponseDto = {
|
|
4859
|
+
asOfDate: string;
|
|
4860
|
+
baseCurrency: string;
|
|
4861
|
+
/**
|
|
4862
|
+
* Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).
|
|
4863
|
+
*/
|
|
4864
|
+
method: 'average' | 'FIFO';
|
|
4865
|
+
rows: Array<HoldingPnlRowDto>;
|
|
4866
|
+
warnings: Array<HoldingPnlWarningDto>;
|
|
4867
|
+
};
|
|
4868
|
+
|
|
4869
|
+
/**
|
|
4870
|
+
* Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).
|
|
4871
|
+
*/
|
|
4872
|
+
export type method = 'average' | 'FIFO';
|
|
4873
|
+
|
|
4874
|
+
export type CreateBeanPriceDto = {
|
|
4875
|
+
/**
|
|
4876
|
+
* Currency being priced (e.g., USD, AAPL, BTC)
|
|
4877
|
+
*/
|
|
4878
|
+
currency: string;
|
|
4879
|
+
/**
|
|
4880
|
+
* Quote currency (pricing currency, e.g., CNY, EUR)
|
|
4881
|
+
*/
|
|
4882
|
+
quoteCurrency: string;
|
|
4883
|
+
/**
|
|
4884
|
+
* Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.
|
|
4885
|
+
*/
|
|
4886
|
+
amount: number;
|
|
4887
|
+
/**
|
|
4888
|
+
* Price date (ISO 8601 format)
|
|
4889
|
+
*/
|
|
4890
|
+
date: string;
|
|
4891
|
+
/**
|
|
4892
|
+
* Metadata (validated by Zod schema, max field lengths enforced)
|
|
4893
|
+
*/
|
|
4894
|
+
metadata?: {
|
|
4895
|
+
[key: string]: unknown;
|
|
4896
|
+
};
|
|
4897
|
+
};
|
|
4898
|
+
|
|
4899
|
+
export type PriceResponseDto = {
|
|
4900
|
+
/**
|
|
4901
|
+
* Unique identifier
|
|
4902
|
+
*/
|
|
4903
|
+
id: string;
|
|
4904
|
+
/**
|
|
4905
|
+
* User ID (owner of the price)
|
|
4906
|
+
*/
|
|
4907
|
+
userId: string;
|
|
4908
|
+
/**
|
|
4909
|
+
* Currency being priced (e.g., USD, AAPL, BTC)
|
|
4910
|
+
*/
|
|
4911
|
+
currency: string;
|
|
4912
|
+
/**
|
|
4913
|
+
* Quote currency (pricing currency, e.g., USD, CNY)
|
|
4914
|
+
*/
|
|
4915
|
+
quoteCurrency: string;
|
|
4916
|
+
/**
|
|
4917
|
+
* Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.
|
|
4918
|
+
*/
|
|
4919
|
+
amount: number;
|
|
4920
|
+
/**
|
|
4921
|
+
* Price date (ISO 8601 format). Represents the date this price was valid.
|
|
4922
|
+
*/
|
|
4923
|
+
date: string;
|
|
4924
|
+
/**
|
|
4925
|
+
* Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.
|
|
4926
|
+
*/
|
|
4927
|
+
meta: {
|
|
4928
|
+
[key: string]: unknown;
|
|
4929
|
+
};
|
|
4930
|
+
/**
|
|
4931
|
+
* Creation timestamp
|
|
4932
|
+
*/
|
|
4933
|
+
createdAt: string;
|
|
4934
|
+
/**
|
|
4935
|
+
* Last update timestamp
|
|
4936
|
+
*/
|
|
4937
|
+
updatedAt: string;
|
|
4938
|
+
};
|
|
4939
|
+
|
|
4940
|
+
export type PriceListResponseDto = {
|
|
4941
|
+
/**
|
|
4942
|
+
* List of prices
|
|
4943
|
+
*/
|
|
4944
|
+
items: Array<PriceResponseDto>;
|
|
4945
|
+
/**
|
|
4946
|
+
* Total number of prices
|
|
4947
|
+
*/
|
|
4948
|
+
total: number;
|
|
4949
|
+
};
|
|
4950
|
+
|
|
4951
|
+
export type UpdateBeanPriceDto = {
|
|
4952
|
+
/**
|
|
4953
|
+
* Currency being priced
|
|
4954
|
+
*/
|
|
4955
|
+
currency?: string;
|
|
4956
|
+
/**
|
|
4957
|
+
* Quote currency (pricing currency)
|
|
4958
|
+
*/
|
|
4959
|
+
quoteCurrency?: string;
|
|
4960
|
+
/**
|
|
4961
|
+
* Price amount (MUST be >= 0 per Beancount spec)
|
|
4962
|
+
*/
|
|
4963
|
+
amount?: number;
|
|
4964
|
+
/**
|
|
4965
|
+
* Price date (ISO 8601 format)
|
|
4966
|
+
*/
|
|
4967
|
+
date?: string;
|
|
4968
|
+
/**
|
|
4969
|
+
* Metadata
|
|
4970
|
+
*/
|
|
4971
|
+
metadata?: {
|
|
4972
|
+
[key: string]: unknown;
|
|
4973
|
+
};
|
|
4974
|
+
};
|
|
4975
|
+
|
|
4976
|
+
export type CurrencyBalanceDto = {
|
|
4977
|
+
/**
|
|
4978
|
+
* ISO 4217 currency code
|
|
4979
|
+
*/
|
|
4980
|
+
currency: string;
|
|
4981
|
+
/**
|
|
4982
|
+
* Balance amount
|
|
4983
|
+
*/
|
|
4984
|
+
balance: string;
|
|
4985
|
+
};
|
|
4986
|
+
|
|
4987
|
+
export type TimeSeriesPointDto = {
|
|
4988
|
+
/**
|
|
4989
|
+
* Date in YYYY-MM-DD format
|
|
4990
|
+
*/
|
|
4991
|
+
date: string;
|
|
4992
|
+
/**
|
|
4993
|
+
* Value at this date (in base currency)
|
|
4994
|
+
*/
|
|
4995
|
+
value: string;
|
|
4996
|
+
/**
|
|
4997
|
+
* Change from previous point
|
|
4998
|
+
*/
|
|
4999
|
+
change?: {
|
|
5000
|
+
[key: string]: unknown;
|
|
5001
|
+
};
|
|
5002
|
+
/**
|
|
5003
|
+
* Total assets at this date (in base currency)
|
|
5004
|
+
*/
|
|
5005
|
+
assets?: string;
|
|
5006
|
+
/**
|
|
5007
|
+
* Total liabilities at this date (in base currency)
|
|
5008
|
+
*/
|
|
5009
|
+
liabilities?: string;
|
|
5010
|
+
/**
|
|
5011
|
+
* Multi-currency breakdown for this point
|
|
5012
|
+
*/
|
|
5013
|
+
byCurrency?: Array<CurrencyBalanceDto>;
|
|
5014
|
+
};
|
|
5015
|
+
|
|
5016
|
+
export type TrendSummaryDto = {
|
|
5017
|
+
/**
|
|
5018
|
+
* Value at start of period
|
|
5019
|
+
*/
|
|
5020
|
+
startValue: string;
|
|
5021
|
+
/**
|
|
5022
|
+
* Value at end of period
|
|
5023
|
+
*/
|
|
5024
|
+
endValue: string;
|
|
5025
|
+
/**
|
|
5026
|
+
* Total change over period
|
|
5027
|
+
*/
|
|
5028
|
+
totalChange: string;
|
|
5029
|
+
/**
|
|
5030
|
+
* Total change percentage
|
|
5031
|
+
*/
|
|
5032
|
+
totalChangePercentage: string;
|
|
5033
|
+
};
|
|
5034
|
+
|
|
5035
|
+
export type MultiCurrencyPointDto = {
|
|
5036
|
+
/**
|
|
5037
|
+
* Date in YYYY-MM-DD format
|
|
5038
|
+
*/
|
|
5039
|
+
date: string;
|
|
5040
|
+
/**
|
|
5041
|
+
* Balances by currency
|
|
5042
|
+
*/
|
|
5043
|
+
byCurrency: Array<CurrencyBalanceDto>;
|
|
5044
|
+
};
|
|
5045
|
+
|
|
5046
|
+
export type PortfolioTrendsResponseDto = {
|
|
5047
|
+
/**
|
|
5048
|
+
* Time series data points
|
|
5049
|
+
*/
|
|
5050
|
+
series: Array<TimeSeriesPointDto>;
|
|
5051
|
+
/**
|
|
5052
|
+
* Period summary
|
|
5053
|
+
*/
|
|
5054
|
+
summary: TrendSummaryDto;
|
|
5055
|
+
/**
|
|
5056
|
+
* Period requested
|
|
5057
|
+
*/
|
|
5058
|
+
period: string;
|
|
5059
|
+
/**
|
|
5060
|
+
* Data granularity
|
|
5061
|
+
*/
|
|
5062
|
+
granularity: string;
|
|
5063
|
+
/**
|
|
5064
|
+
* Base currency for converted values
|
|
5065
|
+
*/
|
|
5066
|
+
currency: string;
|
|
5067
|
+
/**
|
|
5068
|
+
* Multi-currency time series (each point has currency breakdown)
|
|
5069
|
+
*/
|
|
5070
|
+
byCurrency?: Array<MultiCurrencyPointDto>;
|
|
5071
|
+
/**
|
|
5072
|
+
* Exchange rate warnings
|
|
5073
|
+
*/
|
|
5074
|
+
warnings?: Array<ExchangeRateWarningDto>;
|
|
5075
|
+
};
|
|
5076
|
+
|
|
5077
|
+
export type CashFlowPointDto = {
|
|
5078
|
+
/**
|
|
5079
|
+
* Month key (YYYY-MM)
|
|
5080
|
+
*/
|
|
5081
|
+
month: string;
|
|
5082
|
+
/**
|
|
5083
|
+
* Income in base currency (absolute, converted)
|
|
5084
|
+
*/
|
|
5085
|
+
income: string;
|
|
5086
|
+
/**
|
|
5087
|
+
* Expense in base currency (absolute, converted)
|
|
5088
|
+
*/
|
|
5089
|
+
expense: string;
|
|
5090
|
+
/**
|
|
5091
|
+
* netSavings = income − expense (savings positive)
|
|
5092
|
+
*/
|
|
5093
|
+
netSavings: string;
|
|
5094
|
+
};
|
|
5095
|
+
|
|
5096
|
+
export type CashFlowTrendSummaryDto = {
|
|
5097
|
+
/**
|
|
5098
|
+
* Total income across the period
|
|
5099
|
+
*/
|
|
5100
|
+
totalIncome: string;
|
|
5101
|
+
/**
|
|
5102
|
+
* Total expense across the period
|
|
5103
|
+
*/
|
|
5104
|
+
totalExpense: string;
|
|
5105
|
+
/**
|
|
5106
|
+
* income − expense across the period
|
|
5107
|
+
*/
|
|
5108
|
+
totalNetSavings: string;
|
|
5109
|
+
/**
|
|
5110
|
+
* totalNetSavings divided by the window length (N months, incl. zero-filled)
|
|
5111
|
+
*/
|
|
5112
|
+
averageMonthlyNetSavings: string;
|
|
5113
|
+
};
|
|
5114
|
+
|
|
5115
|
+
export type CashFlowTrendsResponseDto = {
|
|
5116
|
+
/**
|
|
5117
|
+
* Monthly cash-flow series (fixed N-month window, zero-filled)
|
|
5118
|
+
*/
|
|
5119
|
+
series: Array<CashFlowPointDto>;
|
|
5120
|
+
/**
|
|
5121
|
+
* Period totals
|
|
5122
|
+
*/
|
|
5123
|
+
summary: CashFlowTrendSummaryDto;
|
|
5124
|
+
/**
|
|
5125
|
+
* Period requested
|
|
5126
|
+
*/
|
|
5127
|
+
period: string;
|
|
5128
|
+
/**
|
|
5129
|
+
* Data granularity (v1 returns month buckets)
|
|
5130
|
+
*/
|
|
5131
|
+
granularity: string;
|
|
5132
|
+
/**
|
|
5133
|
+
* Base currency for converted values
|
|
5134
|
+
*/
|
|
5135
|
+
currency: string;
|
|
5136
|
+
/**
|
|
5137
|
+
* Exchange rate warnings (e.g. missing rate for a currency)
|
|
5138
|
+
*/
|
|
5139
|
+
warnings?: Array<ExchangeRateWarningDto>;
|
|
5140
|
+
};
|
|
5141
|
+
|
|
5142
|
+
export type GenerateSnapshotBody = unknown;
|
|
5143
|
+
|
|
5144
|
+
export type GenerateSnapshotResponse = unknown;
|
|
5145
|
+
|
|
5146
|
+
export type BackfillSnapshotsBody = unknown;
|
|
5147
|
+
|
|
5148
|
+
export type BackfillSnapshotsResponse = unknown;
|
|
5149
|
+
|
|
5150
|
+
export type AnonymousLoginDto = {
|
|
5151
|
+
/**
|
|
5152
|
+
* Access token for anonymous login
|
|
5153
|
+
*/
|
|
5154
|
+
accessToken: string;
|
|
5155
|
+
};
|
|
5156
|
+
|
|
5157
|
+
export type AccountControllerCreateData = {
|
|
5158
|
+
/**
|
|
5159
|
+
* Region code for tenant context
|
|
5160
|
+
*/
|
|
5161
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
5162
|
+
requestBody: CreateAccountDto;
|
|
5163
|
+
};
|
|
5164
|
+
|
|
5165
|
+
export type AccountControllerCreateResponse = AccountResponseDto;
|
|
5166
|
+
|
|
5167
|
+
export type AccountControllerFindAllData = {
|
|
5168
|
+
/**
|
|
5169
|
+
* Filter by custom (user-created) accounts only
|
|
5170
|
+
*/
|
|
5171
|
+
isCustom?: boolean;
|
|
5172
|
+
/**
|
|
5173
|
+
* Maximum number of results
|
|
5174
|
+
*/
|
|
5175
|
+
limit?: number;
|
|
5176
|
+
/**
|
|
5177
|
+
* Number of results to skip
|
|
4508
5178
|
*/
|
|
4509
5179
|
offset?: number;
|
|
4510
5180
|
/**
|
|
@@ -4655,6 +5325,10 @@ export type TransactionControllerListData = {
|
|
|
4655
5325
|
* Filter by account ID (transactions with postings to this account)
|
|
4656
5326
|
*/
|
|
4657
5327
|
accountId?: string;
|
|
5328
|
+
/**
|
|
5329
|
+
* Filter by ADR-0075 functional category (Group segment); matches any posting to an Expenses/Income account whose derived Group segment equals this value
|
|
5330
|
+
*/
|
|
5331
|
+
category?: string;
|
|
4658
5332
|
/**
|
|
4659
5333
|
* Filter by start date (inclusive), format: YYYY-MM-DD
|
|
4660
5334
|
*/
|
|
@@ -5646,6 +6320,104 @@ export type PropertyControllerDeleteData = {
|
|
|
5646
6320
|
|
|
5647
6321
|
export type PropertyControllerDeleteResponse = void;
|
|
5648
6322
|
|
|
6323
|
+
export type EventControllerCreateData = {
|
|
6324
|
+
/**
|
|
6325
|
+
* Region code for tenant context (decorative for life events)
|
|
6326
|
+
*/
|
|
6327
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6328
|
+
requestBody: CreateBeanEventDto;
|
|
6329
|
+
};
|
|
6330
|
+
|
|
6331
|
+
export type EventControllerCreateResponse = EventResponseDto;
|
|
6332
|
+
|
|
6333
|
+
export type EventControllerFindAllData = {
|
|
6334
|
+
/**
|
|
6335
|
+
* Filter life events from this date (ISO 8601 format)
|
|
6336
|
+
*/
|
|
6337
|
+
from?: string;
|
|
6338
|
+
/**
|
|
6339
|
+
* Number of items per page (default: 20, max: 100)
|
|
6340
|
+
*/
|
|
6341
|
+
limit?: number;
|
|
6342
|
+
/**
|
|
6343
|
+
* Page number for pagination (default: 1)
|
|
6344
|
+
*/
|
|
6345
|
+
page?: number;
|
|
6346
|
+
/**
|
|
6347
|
+
* Search term for description (case-insensitive partial match)
|
|
6348
|
+
*/
|
|
6349
|
+
q?: string;
|
|
6350
|
+
/**
|
|
6351
|
+
* Region code for tenant context (decorative for life events)
|
|
6352
|
+
*/
|
|
6353
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6354
|
+
/**
|
|
6355
|
+
* Filter life events to this date (ISO 8601 format)
|
|
6356
|
+
*/
|
|
6357
|
+
to?: string;
|
|
6358
|
+
/**
|
|
6359
|
+
* Filter by life event type (exact match)
|
|
6360
|
+
*/
|
|
6361
|
+
type?: string;
|
|
6362
|
+
};
|
|
6363
|
+
|
|
6364
|
+
export type EventControllerFindAllResponse = EventListResponseDto;
|
|
6365
|
+
|
|
6366
|
+
export type EventControllerFindOneData = {
|
|
6367
|
+
/**
|
|
6368
|
+
* Life event ID
|
|
6369
|
+
*/
|
|
6370
|
+
id: string;
|
|
6371
|
+
/**
|
|
6372
|
+
* Region code for tenant context (decorative for life events)
|
|
6373
|
+
*/
|
|
6374
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6375
|
+
};
|
|
6376
|
+
|
|
6377
|
+
export type EventControllerFindOneResponse = EventResponseDto;
|
|
6378
|
+
|
|
6379
|
+
export type EventControllerUpdateData = {
|
|
6380
|
+
/**
|
|
6381
|
+
* Life event ID
|
|
6382
|
+
*/
|
|
6383
|
+
id: string;
|
|
6384
|
+
/**
|
|
6385
|
+
* Region code for tenant context (decorative for life events)
|
|
6386
|
+
*/
|
|
6387
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6388
|
+
requestBody: UpdateBeanEventDto;
|
|
6389
|
+
};
|
|
6390
|
+
|
|
6391
|
+
export type EventControllerUpdateResponse = EventResponseDto;
|
|
6392
|
+
|
|
6393
|
+
export type EventControllerDeleteData = {
|
|
6394
|
+
/**
|
|
6395
|
+
* Life event ID
|
|
6396
|
+
*/
|
|
6397
|
+
id: string;
|
|
6398
|
+
/**
|
|
6399
|
+
* Region code for tenant context (decorative for life events)
|
|
6400
|
+
*/
|
|
6401
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6402
|
+
};
|
|
6403
|
+
|
|
6404
|
+
export type EventControllerDeleteResponse = void;
|
|
6405
|
+
|
|
6406
|
+
export type EventControllerGetSliceData = {
|
|
6407
|
+
accountPattern: string;
|
|
6408
|
+
granularity: string;
|
|
6409
|
+
/**
|
|
6410
|
+
* Life event ID
|
|
6411
|
+
*/
|
|
6412
|
+
id: string;
|
|
6413
|
+
/**
|
|
6414
|
+
* Region code for tenant context (decorative for life events)
|
|
6415
|
+
*/
|
|
6416
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6417
|
+
};
|
|
6418
|
+
|
|
6419
|
+
export type EventControllerGetSliceResponse = unknown;
|
|
6420
|
+
|
|
5649
6421
|
export type ExportControllerExportBeancountResponse = unknown;
|
|
5650
6422
|
|
|
5651
6423
|
export type FileImportControllerImportFileData = {
|
|
@@ -5794,9 +6566,9 @@ export type ProviderSyncControllerSyncData = {
|
|
|
5794
6566
|
| 'beancount-direct'
|
|
5795
6567
|
| 'parsed-bill';
|
|
5796
6568
|
/**
|
|
5797
|
-
* Region code
|
|
6569
|
+
* Region code for tenant context
|
|
5798
6570
|
*/
|
|
5799
|
-
region:
|
|
6571
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
5800
6572
|
requestBody: ProviderSyncDto;
|
|
5801
6573
|
};
|
|
5802
6574
|
|
|
@@ -5830,94 +6602,266 @@ export type TelemetryControllerReportTelemetryData = {
|
|
|
5830
6602
|
* Region code for tenant context
|
|
5831
6603
|
*/
|
|
5832
6604
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
5833
|
-
requestBody: ParserTelemetryReportDto;
|
|
6605
|
+
requestBody: ParserTelemetryReportDto;
|
|
6606
|
+
};
|
|
6607
|
+
|
|
6608
|
+
export type TelemetryControllerReportTelemetryResponse = unknown;
|
|
6609
|
+
|
|
6610
|
+
export type TelemetryControllerReportCoverageMissData = {
|
|
6611
|
+
/**
|
|
6612
|
+
* Region code for tenant context
|
|
6613
|
+
*/
|
|
6614
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6615
|
+
requestBody: UncoveredFormatMissDto;
|
|
6616
|
+
};
|
|
6617
|
+
|
|
6618
|
+
export type TelemetryControllerReportCoverageMissResponse = unknown;
|
|
6619
|
+
|
|
6620
|
+
export type TelemetryControllerGetCoverageMetricsData = {
|
|
6621
|
+
/**
|
|
6622
|
+
* Region code for tenant context
|
|
6623
|
+
*/
|
|
6624
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6625
|
+
/**
|
|
6626
|
+
* Top-N uncovered formats (default 10)
|
|
6627
|
+
*/
|
|
6628
|
+
topN?: unknown;
|
|
6629
|
+
};
|
|
6630
|
+
|
|
6631
|
+
export type TelemetryControllerGetCoverageMetricsResponse = unknown;
|
|
6632
|
+
|
|
6633
|
+
export type NlpControllerProcessNaturalLanguageData = {
|
|
6634
|
+
/**
|
|
6635
|
+
* Region code for tenant context
|
|
6636
|
+
*/
|
|
6637
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6638
|
+
/**
|
|
6639
|
+
* Natural language transaction input with optional session ID
|
|
6640
|
+
*/
|
|
6641
|
+
requestBody: ProcessNlpDto;
|
|
6642
|
+
};
|
|
6643
|
+
|
|
6644
|
+
export type NlpControllerProcessNaturalLanguageResponse = NlpResponseDto;
|
|
6645
|
+
|
|
6646
|
+
export type NlpControllerClearSessionData = {
|
|
6647
|
+
/**
|
|
6648
|
+
* Region code for tenant context
|
|
6649
|
+
*/
|
|
6650
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6651
|
+
/**
|
|
6652
|
+
* Specific session ID to clear (defaults to user session)
|
|
6653
|
+
*/
|
|
6654
|
+
sessionId?: string;
|
|
6655
|
+
};
|
|
6656
|
+
|
|
6657
|
+
export type NlpControllerClearSessionResponse = void;
|
|
6658
|
+
|
|
6659
|
+
export type NlpControllerGetSessionData = {
|
|
6660
|
+
/**
|
|
6661
|
+
* Region code for tenant context
|
|
6662
|
+
*/
|
|
6663
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6664
|
+
/**
|
|
6665
|
+
* Specific session ID to get (defaults to user session)
|
|
6666
|
+
*/
|
|
6667
|
+
sessionId?: string;
|
|
6668
|
+
};
|
|
6669
|
+
|
|
6670
|
+
export type NlpControllerGetSessionResponse = unknown;
|
|
6671
|
+
|
|
6672
|
+
export type DashboardControllerGetNetWorthData = {
|
|
6673
|
+
/**
|
|
6674
|
+
* Date for balance calculation (ISO 8601 format)
|
|
6675
|
+
*/
|
|
6676
|
+
date?: string;
|
|
6677
|
+
/**
|
|
6678
|
+
* Region code for tenant context
|
|
6679
|
+
*/
|
|
6680
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6681
|
+
};
|
|
6682
|
+
|
|
6683
|
+
export type DashboardControllerGetNetWorthResponse = NetWorthResponseDto;
|
|
6684
|
+
|
|
6685
|
+
export type DashboardControllerGetAccountsData = {
|
|
6686
|
+
/**
|
|
6687
|
+
* Scope to a single account (only valid with groupBy=holdingAssetClass, ADR-0105 §6)
|
|
6688
|
+
*/
|
|
6689
|
+
accountId?: string;
|
|
6690
|
+
/**
|
|
6691
|
+
* Date for balance calculation (ISO 8601 format)
|
|
6692
|
+
*/
|
|
6693
|
+
date?: string;
|
|
6694
|
+
/**
|
|
6695
|
+
* Grouping strategy
|
|
6696
|
+
*/
|
|
6697
|
+
groupBy?:
|
|
6698
|
+
| 'platform'
|
|
6699
|
+
| 'assetClass'
|
|
6700
|
+
| 'holdingAssetClass'
|
|
6701
|
+
| 'holdingAssetClassByAccount';
|
|
6702
|
+
/**
|
|
6703
|
+
* Region code for tenant context
|
|
6704
|
+
*/
|
|
6705
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6706
|
+
};
|
|
6707
|
+
|
|
6708
|
+
export type DashboardControllerGetAccountsResponse =
|
|
6709
|
+
| AccountsResponseDto
|
|
6710
|
+
| AssetClassAccountsResponseDto
|
|
6711
|
+
| HoldingAssetClassCrossAccountResponseDto;
|
|
6712
|
+
|
|
6713
|
+
export type DashboardControllerGetCashFlowData = {
|
|
6714
|
+
/**
|
|
6715
|
+
* Period in YYYY-MM format
|
|
6716
|
+
*/
|
|
6717
|
+
period: string;
|
|
6718
|
+
/**
|
|
6719
|
+
* Region code for tenant context
|
|
6720
|
+
*/
|
|
6721
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6722
|
+
};
|
|
6723
|
+
|
|
6724
|
+
export type DashboardControllerGetCashFlowResponse = CashFlowResponseDto;
|
|
6725
|
+
|
|
6726
|
+
export type DashboardControllerGetExpensesData = {
|
|
6727
|
+
/**
|
|
6728
|
+
* Account root to aggregate (expense → ^Expenses:, income → ^Income:)
|
|
6729
|
+
*/
|
|
6730
|
+
flow?: 'expense' | 'income';
|
|
6731
|
+
/**
|
|
6732
|
+
* Grouping strategy
|
|
6733
|
+
*/
|
|
6734
|
+
groupBy?: 'category';
|
|
6735
|
+
/**
|
|
6736
|
+
* Time window (1m = current calendar month)
|
|
6737
|
+
*/
|
|
6738
|
+
period?: '1m' | '3m' | '6m' | '1y';
|
|
6739
|
+
/**
|
|
6740
|
+
* Region code for tenant context
|
|
6741
|
+
*/
|
|
6742
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6743
|
+
};
|
|
6744
|
+
|
|
6745
|
+
export type DashboardControllerGetExpensesResponse =
|
|
6746
|
+
ExpensesByCategoryResponseDto;
|
|
6747
|
+
|
|
6748
|
+
export type HoldingPnlControllerGetHoldingPnlData = {
|
|
6749
|
+
/**
|
|
6750
|
+
* Scope to a single account
|
|
6751
|
+
*/
|
|
6752
|
+
accountId?: string;
|
|
6753
|
+
/**
|
|
6754
|
+
* As-of date (ISO 8601), defaults to today
|
|
6755
|
+
*/
|
|
6756
|
+
asOf?: string;
|
|
6757
|
+
/**
|
|
6758
|
+
* Realized-P&L lot-matching method (default average). Does not affect the average-cost unrealized basis.
|
|
6759
|
+
*/
|
|
6760
|
+
method?: 'FIFO' | 'average';
|
|
6761
|
+
/**
|
|
6762
|
+
* Region code for tenant context
|
|
6763
|
+
*/
|
|
6764
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6765
|
+
};
|
|
6766
|
+
|
|
6767
|
+
export type HoldingPnlControllerGetHoldingPnlResponse = HoldingPnlResponseDto;
|
|
6768
|
+
|
|
6769
|
+
export type PriceControllerCreateData = {
|
|
6770
|
+
/**
|
|
6771
|
+
* Region code for tenant context
|
|
6772
|
+
*/
|
|
6773
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6774
|
+
requestBody: CreateBeanPriceDto;
|
|
5834
6775
|
};
|
|
5835
6776
|
|
|
5836
|
-
export type
|
|
6777
|
+
export type PriceControllerCreateResponse = PriceResponseDto;
|
|
5837
6778
|
|
|
5838
|
-
export type
|
|
6779
|
+
export type PriceControllerFindAllData = {
|
|
5839
6780
|
/**
|
|
5840
|
-
*
|
|
6781
|
+
* Filter by currency (e.g., BTC, AAPL, USD)
|
|
5841
6782
|
*/
|
|
5842
|
-
|
|
6783
|
+
currency?: string;
|
|
5843
6784
|
/**
|
|
5844
|
-
*
|
|
6785
|
+
* Filter prices from this date (ISO 8601 format)
|
|
5845
6786
|
*/
|
|
5846
|
-
|
|
5847
|
-
|
|
5848
|
-
|
|
5849
|
-
|
|
5850
|
-
|
|
5851
|
-
|
|
6787
|
+
dateFrom?: string;
|
|
6788
|
+
/**
|
|
6789
|
+
* Filter prices to this date (ISO 8601 format)
|
|
6790
|
+
*/
|
|
6791
|
+
dateTo?: string;
|
|
6792
|
+
/**
|
|
6793
|
+
* Number of items per page (default: 20, max: 100)
|
|
6794
|
+
*/
|
|
6795
|
+
limit?: number;
|
|
6796
|
+
/**
|
|
6797
|
+
* Page number for pagination (default: 1)
|
|
6798
|
+
*/
|
|
6799
|
+
page?: number;
|
|
6800
|
+
/**
|
|
6801
|
+
* Filter by quote currency (pricing currency, e.g., USD, CNY)
|
|
6802
|
+
*/
|
|
6803
|
+
quoteCurrency?: string;
|
|
5852
6804
|
/**
|
|
5853
6805
|
* Region code for tenant context
|
|
5854
6806
|
*/
|
|
5855
6807
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
5856
6808
|
/**
|
|
5857
|
-
*
|
|
6809
|
+
* Search term for currency or quoteCurrency (case-insensitive partial match)
|
|
5858
6810
|
*/
|
|
5859
|
-
|
|
6811
|
+
search?: string;
|
|
5860
6812
|
};
|
|
5861
6813
|
|
|
5862
|
-
export type
|
|
6814
|
+
export type PriceControllerFindAllResponse = PriceListResponseDto;
|
|
5863
6815
|
|
|
5864
|
-
export type
|
|
6816
|
+
export type PriceControllerFindOneData = {
|
|
5865
6817
|
/**
|
|
5866
|
-
*
|
|
6818
|
+
* Price ID
|
|
5867
6819
|
*/
|
|
5868
|
-
|
|
6820
|
+
id: string;
|
|
5869
6821
|
/**
|
|
5870
|
-
*
|
|
6822
|
+
* Region code for tenant context
|
|
5871
6823
|
*/
|
|
5872
|
-
|
|
6824
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
5873
6825
|
};
|
|
5874
6826
|
|
|
5875
|
-
export type
|
|
6827
|
+
export type PriceControllerFindOneResponse = PriceResponseDto;
|
|
5876
6828
|
|
|
5877
|
-
export type
|
|
6829
|
+
export type PriceControllerUpdateData = {
|
|
5878
6830
|
/**
|
|
5879
|
-
*
|
|
6831
|
+
* Price ID
|
|
5880
6832
|
*/
|
|
5881
|
-
|
|
6833
|
+
id: string;
|
|
5882
6834
|
/**
|
|
5883
6835
|
* Region code for tenant context
|
|
5884
6836
|
*/
|
|
5885
6837
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6838
|
+
requestBody: UpdateBeanPriceDto;
|
|
5886
6839
|
};
|
|
5887
6840
|
|
|
5888
|
-
export type
|
|
6841
|
+
export type PriceControllerUpdateResponse = PriceResponseDto;
|
|
5889
6842
|
|
|
5890
|
-
export type
|
|
5891
|
-
/**
|
|
5892
|
-
* Date for balance calculation (ISO 8601 format)
|
|
5893
|
-
*/
|
|
5894
|
-
date?: string;
|
|
6843
|
+
export type PriceControllerDeleteData = {
|
|
5895
6844
|
/**
|
|
5896
|
-
*
|
|
6845
|
+
* Price ID
|
|
5897
6846
|
*/
|
|
5898
|
-
|
|
6847
|
+
id: string;
|
|
5899
6848
|
/**
|
|
5900
6849
|
* Region code for tenant context
|
|
5901
6850
|
*/
|
|
5902
6851
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
5903
6852
|
};
|
|
5904
6853
|
|
|
5905
|
-
export type
|
|
5906
|
-
| AccountsResponseDto
|
|
5907
|
-
| AssetClassAccountsResponseDto;
|
|
6854
|
+
export type PriceControllerDeleteResponse = void;
|
|
5908
6855
|
|
|
5909
|
-
export type
|
|
5910
|
-
/**
|
|
5911
|
-
* Period in YYYY-MM format
|
|
5912
|
-
*/
|
|
5913
|
-
period: string;
|
|
6856
|
+
export type PriceControllerBulkCreateData = {
|
|
5914
6857
|
/**
|
|
5915
6858
|
* Region code for tenant context
|
|
5916
6859
|
*/
|
|
5917
6860
|
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6861
|
+
requestBody: Array<string>;
|
|
5918
6862
|
};
|
|
5919
6863
|
|
|
5920
|
-
export type
|
|
6864
|
+
export type PriceControllerBulkCreateResponse = Array<PriceResponseDto>;
|
|
5921
6865
|
|
|
5922
6866
|
export type ReportingControllerGetPortfolioTrendsData = {
|
|
5923
6867
|
/**
|
|
@@ -5937,6 +6881,24 @@ export type ReportingControllerGetPortfolioTrendsData = {
|
|
|
5937
6881
|
export type ReportingControllerGetPortfolioTrendsResponse =
|
|
5938
6882
|
PortfolioTrendsResponseDto;
|
|
5939
6883
|
|
|
6884
|
+
export type ReportingControllerGetCashFlowTrendsData = {
|
|
6885
|
+
/**
|
|
6886
|
+
* Data granularity (accepted for API symmetry; v1 returns month buckets)
|
|
6887
|
+
*/
|
|
6888
|
+
granularity?: 'day' | 'week' | 'month';
|
|
6889
|
+
/**
|
|
6890
|
+
* Time period
|
|
6891
|
+
*/
|
|
6892
|
+
period?: '1m' | '3m' | '6m' | '1y';
|
|
6893
|
+
/**
|
|
6894
|
+
* Region code for tenant context
|
|
6895
|
+
*/
|
|
6896
|
+
region: 'cn' | 'us' | 'de' | 'gb';
|
|
6897
|
+
};
|
|
6898
|
+
|
|
6899
|
+
export type ReportingControllerGetCashFlowTrendsResponse =
|
|
6900
|
+
CashFlowTrendsResponseDto;
|
|
6901
|
+
|
|
5940
6902
|
export type ReportingControllerGenerateSnapshotData = {
|
|
5941
6903
|
/**
|
|
5942
6904
|
* Region code for tenant context
|
|
@@ -7368,6 +8330,102 @@ export type $OpenApiTs = {
|
|
|
7368
8330
|
};
|
|
7369
8331
|
};
|
|
7370
8332
|
};
|
|
8333
|
+
'/api/v1/{region}/bean/events': {
|
|
8334
|
+
post: {
|
|
8335
|
+
req: EventControllerCreateData;
|
|
8336
|
+
res: {
|
|
8337
|
+
/**
|
|
8338
|
+
* Life event created successfully
|
|
8339
|
+
*/
|
|
8340
|
+
201: EventResponseDto;
|
|
8341
|
+
/**
|
|
8342
|
+
* Life event already exists for this (userId, type, date) combination
|
|
8343
|
+
*/
|
|
8344
|
+
409: unknown;
|
|
8345
|
+
};
|
|
8346
|
+
};
|
|
8347
|
+
get: {
|
|
8348
|
+
req: EventControllerFindAllData;
|
|
8349
|
+
res: {
|
|
8350
|
+
/**
|
|
8351
|
+
* Life events retrieved successfully
|
|
8352
|
+
*/
|
|
8353
|
+
200: EventListResponseDto;
|
|
8354
|
+
};
|
|
8355
|
+
};
|
|
8356
|
+
};
|
|
8357
|
+
'/api/v1/{region}/bean/events/{id}': {
|
|
8358
|
+
get: {
|
|
8359
|
+
req: EventControllerFindOneData;
|
|
8360
|
+
res: {
|
|
8361
|
+
/**
|
|
8362
|
+
* Life event retrieved successfully
|
|
8363
|
+
*/
|
|
8364
|
+
200: EventResponseDto;
|
|
8365
|
+
/**
|
|
8366
|
+
* Life event not found
|
|
8367
|
+
*/
|
|
8368
|
+
404: unknown;
|
|
8369
|
+
};
|
|
8370
|
+
};
|
|
8371
|
+
put: {
|
|
8372
|
+
req: EventControllerUpdateData;
|
|
8373
|
+
res: {
|
|
8374
|
+
/**
|
|
8375
|
+
* Life event updated successfully
|
|
8376
|
+
*/
|
|
8377
|
+
200: EventResponseDto;
|
|
8378
|
+
/**
|
|
8379
|
+
* If-Match header is not a valid ISO 8601 date
|
|
8380
|
+
*/
|
|
8381
|
+
400: unknown;
|
|
8382
|
+
/**
|
|
8383
|
+
* Life event not found
|
|
8384
|
+
*/
|
|
8385
|
+
404: unknown;
|
|
8386
|
+
/**
|
|
8387
|
+
* Updated event conflicts with an existing (userId, type, date) combination
|
|
8388
|
+
*/
|
|
8389
|
+
409: unknown;
|
|
8390
|
+
/**
|
|
8391
|
+
* If-Match precondition failed (updatedAt mismatch)
|
|
8392
|
+
*/
|
|
8393
|
+
412: unknown;
|
|
8394
|
+
};
|
|
8395
|
+
};
|
|
8396
|
+
delete: {
|
|
8397
|
+
req: EventControllerDeleteData;
|
|
8398
|
+
res: {
|
|
8399
|
+
/**
|
|
8400
|
+
* Life event deleted successfully
|
|
8401
|
+
*/
|
|
8402
|
+
204: void;
|
|
8403
|
+
/**
|
|
8404
|
+
* Life event not found
|
|
8405
|
+
*/
|
|
8406
|
+
404: unknown;
|
|
8407
|
+
};
|
|
8408
|
+
};
|
|
8409
|
+
};
|
|
8410
|
+
'/api/v1/{region}/bean/events/{id}/slice': {
|
|
8411
|
+
get: {
|
|
8412
|
+
req: EventControllerGetSliceData;
|
|
8413
|
+
res: {
|
|
8414
|
+
/**
|
|
8415
|
+
* Time-series sliced by the life event range
|
|
8416
|
+
*/
|
|
8417
|
+
200: unknown;
|
|
8418
|
+
/**
|
|
8419
|
+
* accountPattern query param is empty
|
|
8420
|
+
*/
|
|
8421
|
+
400: unknown;
|
|
8422
|
+
/**
|
|
8423
|
+
* Life event not found
|
|
8424
|
+
*/
|
|
8425
|
+
404: unknown;
|
|
8426
|
+
};
|
|
8427
|
+
};
|
|
8428
|
+
};
|
|
7371
8429
|
'/api/v1/{region}/bean/export/beancount': {
|
|
7372
8430
|
get: {
|
|
7373
8431
|
res: {
|
|
@@ -7658,6 +8716,32 @@ export type $OpenApiTs = {
|
|
|
7658
8716
|
};
|
|
7659
8717
|
};
|
|
7660
8718
|
};
|
|
8719
|
+
'/api/v1/{region}/bean/import/parser-coverage-miss': {
|
|
8720
|
+
post: {
|
|
8721
|
+
req: TelemetryControllerReportCoverageMissData;
|
|
8722
|
+
res: {
|
|
8723
|
+
/**
|
|
8724
|
+
* Coverage miss report received
|
|
8725
|
+
*/
|
|
8726
|
+
200: unknown;
|
|
8727
|
+
/**
|
|
8728
|
+
* Unauthorized
|
|
8729
|
+
*/
|
|
8730
|
+
401: unknown;
|
|
8731
|
+
};
|
|
8732
|
+
};
|
|
8733
|
+
};
|
|
8734
|
+
'/api/v1/{region}/bean/import/parser-coverage-metrics': {
|
|
8735
|
+
get: {
|
|
8736
|
+
req: TelemetryControllerGetCoverageMetricsData;
|
|
8737
|
+
res: {
|
|
8738
|
+
/**
|
|
8739
|
+
* Coverage metrics
|
|
8740
|
+
*/
|
|
8741
|
+
200: unknown;
|
|
8742
|
+
};
|
|
8743
|
+
};
|
|
8744
|
+
};
|
|
7661
8745
|
'/api/v1/{region}/bean/nlp/process': {
|
|
7662
8746
|
post: {
|
|
7663
8747
|
req: NlpControllerProcessNaturalLanguageData;
|
|
@@ -7727,7 +8811,10 @@ export type $OpenApiTs = {
|
|
|
7727
8811
|
/**
|
|
7728
8812
|
* Accounts retrieved successfully. Response type depends on groupBy parameter.
|
|
7729
8813
|
*/
|
|
7730
|
-
200:
|
|
8814
|
+
200:
|
|
8815
|
+
| AccountsResponseDto
|
|
8816
|
+
| AssetClassAccountsResponseDto
|
|
8817
|
+
| HoldingAssetClassCrossAccountResponseDto;
|
|
7731
8818
|
/**
|
|
7732
8819
|
* User not authenticated
|
|
7733
8820
|
*/
|
|
@@ -7754,6 +8841,128 @@ export type $OpenApiTs = {
|
|
|
7754
8841
|
};
|
|
7755
8842
|
};
|
|
7756
8843
|
};
|
|
8844
|
+
'/api/v1/{region}/dashboard/expenses': {
|
|
8845
|
+
get: {
|
|
8846
|
+
req: DashboardControllerGetExpensesData;
|
|
8847
|
+
res: {
|
|
8848
|
+
/**
|
|
8849
|
+
* Expenses retrieved successfully
|
|
8850
|
+
*/
|
|
8851
|
+
200: ExpensesByCategoryResponseDto;
|
|
8852
|
+
/**
|
|
8853
|
+
* Invalid groupBy or period
|
|
8854
|
+
*/
|
|
8855
|
+
400: unknown;
|
|
8856
|
+
/**
|
|
8857
|
+
* User not authenticated
|
|
8858
|
+
*/
|
|
8859
|
+
401: unknown;
|
|
8860
|
+
};
|
|
8861
|
+
};
|
|
8862
|
+
};
|
|
8863
|
+
'/api/v1/{region}/investment/holdings/pnl': {
|
|
8864
|
+
get: {
|
|
8865
|
+
req: HoldingPnlControllerGetHoldingPnlData;
|
|
8866
|
+
res: {
|
|
8867
|
+
/**
|
|
8868
|
+
* Holding P&L retrieved successfully
|
|
8869
|
+
*/
|
|
8870
|
+
200: HoldingPnlResponseDto;
|
|
8871
|
+
/**
|
|
8872
|
+
* Invalid asOf format/value/future date, invalid accountId format, or unsupported method
|
|
8873
|
+
*/
|
|
8874
|
+
400: unknown;
|
|
8875
|
+
/**
|
|
8876
|
+
* User not authenticated
|
|
8877
|
+
*/
|
|
8878
|
+
401: unknown;
|
|
8879
|
+
};
|
|
8880
|
+
};
|
|
8881
|
+
};
|
|
8882
|
+
'/api/v1/{region}/bean/prices': {
|
|
8883
|
+
post: {
|
|
8884
|
+
req: PriceControllerCreateData;
|
|
8885
|
+
res: {
|
|
8886
|
+
/**
|
|
8887
|
+
* Price created successfully
|
|
8888
|
+
*/
|
|
8889
|
+
201: PriceResponseDto;
|
|
8890
|
+
/**
|
|
8891
|
+
* Currency or quoteCurrency commodity not found
|
|
8892
|
+
*/
|
|
8893
|
+
404: unknown;
|
|
8894
|
+
/**
|
|
8895
|
+
* Price already exists for this currency pair and date
|
|
8896
|
+
*/
|
|
8897
|
+
409: unknown;
|
|
8898
|
+
};
|
|
8899
|
+
};
|
|
8900
|
+
get: {
|
|
8901
|
+
req: PriceControllerFindAllData;
|
|
8902
|
+
res: {
|
|
8903
|
+
/**
|
|
8904
|
+
* Prices retrieved successfully
|
|
8905
|
+
*/
|
|
8906
|
+
200: PriceListResponseDto;
|
|
8907
|
+
};
|
|
8908
|
+
};
|
|
8909
|
+
};
|
|
8910
|
+
'/api/v1/{region}/bean/prices/{id}': {
|
|
8911
|
+
get: {
|
|
8912
|
+
req: PriceControllerFindOneData;
|
|
8913
|
+
res: {
|
|
8914
|
+
/**
|
|
8915
|
+
* Price retrieved successfully
|
|
8916
|
+
*/
|
|
8917
|
+
200: PriceResponseDto;
|
|
8918
|
+
/**
|
|
8919
|
+
* Price not found
|
|
8920
|
+
*/
|
|
8921
|
+
404: unknown;
|
|
8922
|
+
};
|
|
8923
|
+
};
|
|
8924
|
+
put: {
|
|
8925
|
+
req: PriceControllerUpdateData;
|
|
8926
|
+
res: {
|
|
8927
|
+
/**
|
|
8928
|
+
* Price updated successfully
|
|
8929
|
+
*/
|
|
8930
|
+
200: PriceResponseDto;
|
|
8931
|
+
/**
|
|
8932
|
+
* Price not found
|
|
8933
|
+
*/
|
|
8934
|
+
404: unknown;
|
|
8935
|
+
/**
|
|
8936
|
+
* Updated price conflicts with existing price
|
|
8937
|
+
*/
|
|
8938
|
+
409: unknown;
|
|
8939
|
+
};
|
|
8940
|
+
};
|
|
8941
|
+
delete: {
|
|
8942
|
+
req: PriceControllerDeleteData;
|
|
8943
|
+
res: {
|
|
8944
|
+
/**
|
|
8945
|
+
* Price deleted successfully
|
|
8946
|
+
*/
|
|
8947
|
+
204: void;
|
|
8948
|
+
/**
|
|
8949
|
+
* Price not found
|
|
8950
|
+
*/
|
|
8951
|
+
404: unknown;
|
|
8952
|
+
};
|
|
8953
|
+
};
|
|
8954
|
+
};
|
|
8955
|
+
'/api/v1/{region}/bean/prices/bulk': {
|
|
8956
|
+
post: {
|
|
8957
|
+
req: PriceControllerBulkCreateData;
|
|
8958
|
+
res: {
|
|
8959
|
+
/**
|
|
8960
|
+
* Prices created successfully
|
|
8961
|
+
*/
|
|
8962
|
+
201: Array<PriceResponseDto>;
|
|
8963
|
+
};
|
|
8964
|
+
};
|
|
8965
|
+
};
|
|
7757
8966
|
'/api/v1/{region}/reporting/portfolio/trends': {
|
|
7758
8967
|
get: {
|
|
7759
8968
|
req: ReportingControllerGetPortfolioTrendsData;
|
|
@@ -7769,6 +8978,21 @@ export type $OpenApiTs = {
|
|
|
7769
8978
|
};
|
|
7770
8979
|
};
|
|
7771
8980
|
};
|
|
8981
|
+
'/api/v1/{region}/reporting/cash-flow/trends': {
|
|
8982
|
+
get: {
|
|
8983
|
+
req: ReportingControllerGetCashFlowTrendsData;
|
|
8984
|
+
res: {
|
|
8985
|
+
/**
|
|
8986
|
+
* Cash-flow trends retrieved successfully
|
|
8987
|
+
*/
|
|
8988
|
+
200: CashFlowTrendsResponseDto;
|
|
8989
|
+
/**
|
|
8990
|
+
* User not authenticated
|
|
8991
|
+
*/
|
|
8992
|
+
401: unknown;
|
|
8993
|
+
};
|
|
8994
|
+
};
|
|
8995
|
+
};
|
|
7772
8996
|
'/api/v1/{region}/reporting/snapshots/generate': {
|
|
7773
8997
|
post: {
|
|
7774
8998
|
req: ReportingControllerGenerateSnapshotData;
|