@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
|
@@ -171,6 +171,18 @@ import type {
|
|
|
171
171
|
PropertyControllerUpdateResponse,
|
|
172
172
|
PropertyControllerDeleteData,
|
|
173
173
|
PropertyControllerDeleteResponse,
|
|
174
|
+
EventControllerCreateData,
|
|
175
|
+
EventControllerCreateResponse,
|
|
176
|
+
EventControllerFindAllData,
|
|
177
|
+
EventControllerFindAllResponse,
|
|
178
|
+
EventControllerFindOneData,
|
|
179
|
+
EventControllerFindOneResponse,
|
|
180
|
+
EventControllerUpdateData,
|
|
181
|
+
EventControllerUpdateResponse,
|
|
182
|
+
EventControllerDeleteData,
|
|
183
|
+
EventControllerDeleteResponse,
|
|
184
|
+
EventControllerGetSliceData,
|
|
185
|
+
EventControllerGetSliceResponse,
|
|
174
186
|
ExportControllerExportBeancountResponse,
|
|
175
187
|
FileImportControllerImportFileData,
|
|
176
188
|
FileImportControllerImportFileResponse,
|
|
@@ -202,6 +214,10 @@ import type {
|
|
|
202
214
|
ProviderSyncControllerIsProviderSupportedResponse,
|
|
203
215
|
TelemetryControllerReportTelemetryData,
|
|
204
216
|
TelemetryControllerReportTelemetryResponse,
|
|
217
|
+
TelemetryControllerReportCoverageMissData,
|
|
218
|
+
TelemetryControllerReportCoverageMissResponse,
|
|
219
|
+
TelemetryControllerGetCoverageMetricsData,
|
|
220
|
+
TelemetryControllerGetCoverageMetricsResponse,
|
|
205
221
|
NlpControllerProcessNaturalLanguageData,
|
|
206
222
|
NlpControllerProcessNaturalLanguageResponse,
|
|
207
223
|
NlpControllerClearSessionData,
|
|
@@ -214,8 +230,26 @@ import type {
|
|
|
214
230
|
DashboardControllerGetAccountsResponse,
|
|
215
231
|
DashboardControllerGetCashFlowData,
|
|
216
232
|
DashboardControllerGetCashFlowResponse,
|
|
233
|
+
DashboardControllerGetExpensesData,
|
|
234
|
+
DashboardControllerGetExpensesResponse,
|
|
235
|
+
HoldingPnlControllerGetHoldingPnlData,
|
|
236
|
+
HoldingPnlControllerGetHoldingPnlResponse,
|
|
237
|
+
PriceControllerCreateData,
|
|
238
|
+
PriceControllerCreateResponse,
|
|
239
|
+
PriceControllerFindAllData,
|
|
240
|
+
PriceControllerFindAllResponse,
|
|
241
|
+
PriceControllerFindOneData,
|
|
242
|
+
PriceControllerFindOneResponse,
|
|
243
|
+
PriceControllerUpdateData,
|
|
244
|
+
PriceControllerUpdateResponse,
|
|
245
|
+
PriceControllerDeleteData,
|
|
246
|
+
PriceControllerDeleteResponse,
|
|
247
|
+
PriceControllerBulkCreateData,
|
|
248
|
+
PriceControllerBulkCreateResponse,
|
|
217
249
|
ReportingControllerGetPortfolioTrendsData,
|
|
218
250
|
ReportingControllerGetPortfolioTrendsResponse,
|
|
251
|
+
ReportingControllerGetCashFlowTrendsData,
|
|
252
|
+
ReportingControllerGetCashFlowTrendsResponse,
|
|
219
253
|
ReportingControllerGenerateSnapshotData,
|
|
220
254
|
ReportingControllerGenerateSnapshotResponse,
|
|
221
255
|
ReportingControllerBackfillSnapshotsData,
|
|
@@ -551,6 +585,7 @@ export class BeanTransactionsService {
|
|
|
551
585
|
* @param data.status Filter by transaction status
|
|
552
586
|
* @param data.search Search in narration and payee fields (max 200 chars)
|
|
553
587
|
* @param data.accountId Filter by account ID (transactions with postings to this account)
|
|
588
|
+
* @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an Expenses/Income account whose derived Group segment equals this value
|
|
554
589
|
* @returns TransactionListResponseDto Transaction list
|
|
555
590
|
* @throws ApiError
|
|
556
591
|
*/
|
|
@@ -570,7 +605,8 @@ export class BeanTransactionsService {
|
|
|
570
605
|
dateTo: data.dateTo,
|
|
571
606
|
status: data.status,
|
|
572
607
|
search: data.search,
|
|
573
|
-
accountId: data.accountId
|
|
608
|
+
accountId: data.accountId,
|
|
609
|
+
category: data.category
|
|
574
610
|
},
|
|
575
611
|
errors: {
|
|
576
612
|
400: 'Validation failed',
|
|
@@ -2442,6 +2478,181 @@ export class PropertiesService {
|
|
|
2442
2478
|
}
|
|
2443
2479
|
}
|
|
2444
2480
|
|
|
2481
|
+
export class LifeEventsService {
|
|
2482
|
+
/**
|
|
2483
|
+
* Create a new life event
|
|
2484
|
+
* Creates a new life event entry for the authenticated user. Returns ETag header carrying the row updatedAt.
|
|
2485
|
+
* @param data The data for the request.
|
|
2486
|
+
* @param data.region Region code for tenant context (decorative for life events)
|
|
2487
|
+
* @param data.requestBody
|
|
2488
|
+
* @returns EventResponseDto Life event created successfully
|
|
2489
|
+
* @throws ApiError
|
|
2490
|
+
*/
|
|
2491
|
+
public static eventControllerCreate(
|
|
2492
|
+
data: EventControllerCreateData
|
|
2493
|
+
): CancelablePromise<EventControllerCreateResponse> {
|
|
2494
|
+
return __request(OpenAPI, {
|
|
2495
|
+
method: 'POST',
|
|
2496
|
+
url: '/api/v1/{region}/bean/events',
|
|
2497
|
+
path: {
|
|
2498
|
+
region: data.region
|
|
2499
|
+
},
|
|
2500
|
+
body: data.requestBody,
|
|
2501
|
+
mediaType: 'application/json',
|
|
2502
|
+
errors: {
|
|
2503
|
+
409: 'Life event already exists for this (userId, type, date) combination'
|
|
2504
|
+
}
|
|
2505
|
+
});
|
|
2506
|
+
}
|
|
2507
|
+
|
|
2508
|
+
/**
|
|
2509
|
+
* List user life events
|
|
2510
|
+
* Returns life events for the authenticated user with optional filtering by type, description search, and date range.
|
|
2511
|
+
* @param data The data for the request.
|
|
2512
|
+
* @param data.region Region code for tenant context (decorative for life events)
|
|
2513
|
+
* @param data.type Filter by life event type (exact match)
|
|
2514
|
+
* @param data.q Search term for description (case-insensitive partial match)
|
|
2515
|
+
* @param data.from Filter life events from this date (ISO 8601 format)
|
|
2516
|
+
* @param data.to Filter life events to this date (ISO 8601 format)
|
|
2517
|
+
* @param data.page Page number for pagination (default: 1)
|
|
2518
|
+
* @param data.limit Number of items per page (default: 20, max: 100)
|
|
2519
|
+
* @returns EventListResponseDto Life events retrieved successfully
|
|
2520
|
+
* @throws ApiError
|
|
2521
|
+
*/
|
|
2522
|
+
public static eventControllerFindAll(
|
|
2523
|
+
data: EventControllerFindAllData
|
|
2524
|
+
): CancelablePromise<EventControllerFindAllResponse> {
|
|
2525
|
+
return __request(OpenAPI, {
|
|
2526
|
+
method: 'GET',
|
|
2527
|
+
url: '/api/v1/{region}/bean/events',
|
|
2528
|
+
path: {
|
|
2529
|
+
region: data.region
|
|
2530
|
+
},
|
|
2531
|
+
query: {
|
|
2532
|
+
type: data.type,
|
|
2533
|
+
q: data.q,
|
|
2534
|
+
from: data.from,
|
|
2535
|
+
to: data.to,
|
|
2536
|
+
page: data.page,
|
|
2537
|
+
limit: data.limit
|
|
2538
|
+
}
|
|
2539
|
+
});
|
|
2540
|
+
}
|
|
2541
|
+
|
|
2542
|
+
/**
|
|
2543
|
+
* Get life event by ID
|
|
2544
|
+
* Returns a single life event by its ID. Returns ETag header.
|
|
2545
|
+
* @param data The data for the request.
|
|
2546
|
+
* @param data.id Life event ID
|
|
2547
|
+
* @param data.region Region code for tenant context (decorative for life events)
|
|
2548
|
+
* @returns EventResponseDto Life event retrieved successfully
|
|
2549
|
+
* @throws ApiError
|
|
2550
|
+
*/
|
|
2551
|
+
public static eventControllerFindOne(
|
|
2552
|
+
data: EventControllerFindOneData
|
|
2553
|
+
): CancelablePromise<EventControllerFindOneResponse> {
|
|
2554
|
+
return __request(OpenAPI, {
|
|
2555
|
+
method: 'GET',
|
|
2556
|
+
url: '/api/v1/{region}/bean/events/{id}',
|
|
2557
|
+
path: {
|
|
2558
|
+
id: data.id,
|
|
2559
|
+
region: data.region
|
|
2560
|
+
},
|
|
2561
|
+
errors: {
|
|
2562
|
+
404: 'Life event not found'
|
|
2563
|
+
}
|
|
2564
|
+
});
|
|
2565
|
+
}
|
|
2566
|
+
|
|
2567
|
+
/**
|
|
2568
|
+
* Update a life event
|
|
2569
|
+
* Updates an existing life event. If If-Match header is provided, performs optimistic concurrency check; mismatched updatedAt returns 412.
|
|
2570
|
+
* @param data The data for the request.
|
|
2571
|
+
* @param data.id Life event ID
|
|
2572
|
+
* @param data.region Region code for tenant context (decorative for life events)
|
|
2573
|
+
* @param data.requestBody
|
|
2574
|
+
* @returns EventResponseDto Life event updated successfully
|
|
2575
|
+
* @throws ApiError
|
|
2576
|
+
*/
|
|
2577
|
+
public static eventControllerUpdate(
|
|
2578
|
+
data: EventControllerUpdateData
|
|
2579
|
+
): CancelablePromise<EventControllerUpdateResponse> {
|
|
2580
|
+
return __request(OpenAPI, {
|
|
2581
|
+
method: 'PUT',
|
|
2582
|
+
url: '/api/v1/{region}/bean/events/{id}',
|
|
2583
|
+
path: {
|
|
2584
|
+
id: data.id,
|
|
2585
|
+
region: data.region
|
|
2586
|
+
},
|
|
2587
|
+
body: data.requestBody,
|
|
2588
|
+
mediaType: 'application/json',
|
|
2589
|
+
errors: {
|
|
2590
|
+
400: 'If-Match header is not a valid ISO 8601 date',
|
|
2591
|
+
404: 'Life event not found',
|
|
2592
|
+
409: 'Updated event conflicts with an existing (userId, type, date) combination',
|
|
2593
|
+
412: 'If-Match precondition failed (updatedAt mismatch)'
|
|
2594
|
+
}
|
|
2595
|
+
});
|
|
2596
|
+
}
|
|
2597
|
+
|
|
2598
|
+
/**
|
|
2599
|
+
* Delete a life event
|
|
2600
|
+
* Deletes a life event entry (hard delete). Returns 204.
|
|
2601
|
+
* @param data The data for the request.
|
|
2602
|
+
* @param data.id Life event ID
|
|
2603
|
+
* @param data.region Region code for tenant context (decorative for life events)
|
|
2604
|
+
* @returns void Life event deleted successfully
|
|
2605
|
+
* @throws ApiError
|
|
2606
|
+
*/
|
|
2607
|
+
public static eventControllerDelete(
|
|
2608
|
+
data: EventControllerDeleteData
|
|
2609
|
+
): CancelablePromise<EventControllerDeleteResponse> {
|
|
2610
|
+
return __request(OpenAPI, {
|
|
2611
|
+
method: 'DELETE',
|
|
2612
|
+
url: '/api/v1/{region}/bean/events/{id}',
|
|
2613
|
+
path: {
|
|
2614
|
+
id: data.id,
|
|
2615
|
+
region: data.region
|
|
2616
|
+
},
|
|
2617
|
+
errors: {
|
|
2618
|
+
404: 'Life event not found'
|
|
2619
|
+
}
|
|
2620
|
+
});
|
|
2621
|
+
}
|
|
2622
|
+
|
|
2623
|
+
/**
|
|
2624
|
+
* Slice time-series by a life event (Phase 79)
|
|
2625
|
+
* Returns aggregated time-series for postings matching accountPattern within the half-open date range of the given life event.
|
|
2626
|
+
* @param data The data for the request.
|
|
2627
|
+
* @param data.id Life event ID
|
|
2628
|
+
* @param data.accountPattern
|
|
2629
|
+
* @param data.granularity
|
|
2630
|
+
* @param data.region Region code for tenant context (decorative for life events)
|
|
2631
|
+
* @returns unknown Time-series sliced by the life event range
|
|
2632
|
+
* @throws ApiError
|
|
2633
|
+
*/
|
|
2634
|
+
public static eventControllerGetSlice(
|
|
2635
|
+
data: EventControllerGetSliceData
|
|
2636
|
+
): CancelablePromise<EventControllerGetSliceResponse> {
|
|
2637
|
+
return __request(OpenAPI, {
|
|
2638
|
+
method: 'GET',
|
|
2639
|
+
url: '/api/v1/{region}/bean/events/{id}/slice',
|
|
2640
|
+
path: {
|
|
2641
|
+
id: data.id,
|
|
2642
|
+
region: data.region
|
|
2643
|
+
},
|
|
2644
|
+
query: {
|
|
2645
|
+
accountPattern: data.accountPattern,
|
|
2646
|
+
granularity: data.granularity
|
|
2647
|
+
},
|
|
2648
|
+
errors: {
|
|
2649
|
+
400: 'accountPattern query param is empty',
|
|
2650
|
+
404: 'Life event not found'
|
|
2651
|
+
}
|
|
2652
|
+
});
|
|
2653
|
+
}
|
|
2654
|
+
}
|
|
2655
|
+
|
|
2445
2656
|
export class BeanExportService {
|
|
2446
2657
|
/**
|
|
2447
2658
|
* Export Beancount ledger as ZIP
|
|
@@ -2761,7 +2972,7 @@ export class ProviderSyncService {
|
|
|
2761
2972
|
*
|
|
2762
2973
|
* @param data The data for the request.
|
|
2763
2974
|
* @param data.providerName Provider name
|
|
2764
|
-
* @param data.region Region code
|
|
2975
|
+
* @param data.region Region code for tenant context
|
|
2765
2976
|
* @param data.requestBody
|
|
2766
2977
|
* @returns ProviderSyncResponseDto Sync completed successfully
|
|
2767
2978
|
* @throws ApiError
|
|
@@ -2860,6 +3071,54 @@ export class ImportTelemetryService {
|
|
|
2860
3071
|
}
|
|
2861
3072
|
});
|
|
2862
3073
|
}
|
|
3074
|
+
|
|
3075
|
+
/**
|
|
3076
|
+
* Receive anonymous zero-hit coverage miss report
|
|
3077
|
+
* @param data The data for the request.
|
|
3078
|
+
* @param data.region Region code for tenant context
|
|
3079
|
+
* @param data.requestBody
|
|
3080
|
+
* @returns unknown Coverage miss report received
|
|
3081
|
+
* @throws ApiError
|
|
3082
|
+
*/
|
|
3083
|
+
public static telemetryControllerReportCoverageMiss(
|
|
3084
|
+
data: TelemetryControllerReportCoverageMissData
|
|
3085
|
+
): CancelablePromise<TelemetryControllerReportCoverageMissResponse> {
|
|
3086
|
+
return __request(OpenAPI, {
|
|
3087
|
+
method: 'POST',
|
|
3088
|
+
url: '/api/v1/{region}/bean/import/parser-coverage-miss',
|
|
3089
|
+
path: {
|
|
3090
|
+
region: data.region
|
|
3091
|
+
},
|
|
3092
|
+
body: data.requestBody,
|
|
3093
|
+
mediaType: 'application/json',
|
|
3094
|
+
errors: {
|
|
3095
|
+
401: 'Unauthorized'
|
|
3096
|
+
}
|
|
3097
|
+
});
|
|
3098
|
+
}
|
|
3099
|
+
|
|
3100
|
+
/**
|
|
3101
|
+
* Coverage metrics (uncovered format aggregation)
|
|
3102
|
+
* @param data The data for the request.
|
|
3103
|
+
* @param data.region Region code for tenant context
|
|
3104
|
+
* @param data.topN Top-N uncovered formats (default 10)
|
|
3105
|
+
* @returns unknown Coverage metrics
|
|
3106
|
+
* @throws ApiError
|
|
3107
|
+
*/
|
|
3108
|
+
public static telemetryControllerGetCoverageMetrics(
|
|
3109
|
+
data: TelemetryControllerGetCoverageMetricsData
|
|
3110
|
+
): CancelablePromise<TelemetryControllerGetCoverageMetricsResponse> {
|
|
3111
|
+
return __request(OpenAPI, {
|
|
3112
|
+
method: 'GET',
|
|
3113
|
+
url: '/api/v1/{region}/bean/import/parser-coverage-metrics',
|
|
3114
|
+
path: {
|
|
3115
|
+
region: data.region
|
|
3116
|
+
},
|
|
3117
|
+
query: {
|
|
3118
|
+
topN: data.topN
|
|
3119
|
+
}
|
|
3120
|
+
});
|
|
3121
|
+
}
|
|
2863
3122
|
}
|
|
2864
3123
|
|
|
2865
3124
|
export class BeanNlpService {
|
|
@@ -2980,6 +3239,7 @@ export class DashboardService {
|
|
|
2980
3239
|
* @param data.region Region code for tenant context
|
|
2981
3240
|
* @param data.groupBy Grouping strategy
|
|
2982
3241
|
* @param data.date Date for balance calculation (ISO 8601 format)
|
|
3242
|
+
* @param data.accountId Scope to a single account (only valid with groupBy=holdingAssetClass, ADR-0105 §6)
|
|
2983
3243
|
* @returns unknown Accounts retrieved successfully. Response type depends on groupBy parameter.
|
|
2984
3244
|
* @throws ApiError
|
|
2985
3245
|
*/
|
|
@@ -2994,7 +3254,8 @@ export class DashboardService {
|
|
|
2994
3254
|
},
|
|
2995
3255
|
query: {
|
|
2996
3256
|
groupBy: data.groupBy,
|
|
2997
|
-
date: data.date
|
|
3257
|
+
date: data.date,
|
|
3258
|
+
accountId: data.accountId
|
|
2998
3259
|
},
|
|
2999
3260
|
errors: {
|
|
3000
3261
|
401: 'User not authenticated'
|
|
@@ -3029,6 +3290,239 @@ export class DashboardService {
|
|
|
3029
3290
|
}
|
|
3030
3291
|
});
|
|
3031
3292
|
}
|
|
3293
|
+
|
|
3294
|
+
/**
|
|
3295
|
+
* Get expenses/income grouped by functional category
|
|
3296
|
+
* 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)
|
|
3297
|
+
* @param data The data for the request.
|
|
3298
|
+
* @param data.region Region code for tenant context
|
|
3299
|
+
* @param data.groupBy Grouping strategy
|
|
3300
|
+
* @param data.period Time window (1m = current calendar month)
|
|
3301
|
+
* @param data.flow Account root to aggregate (expense → ^Expenses:, income → ^Income:)
|
|
3302
|
+
* @returns ExpensesByCategoryResponseDto Expenses retrieved successfully
|
|
3303
|
+
* @throws ApiError
|
|
3304
|
+
*/
|
|
3305
|
+
public static dashboardControllerGetExpenses(
|
|
3306
|
+
data: DashboardControllerGetExpensesData
|
|
3307
|
+
): CancelablePromise<DashboardControllerGetExpensesResponse> {
|
|
3308
|
+
return __request(OpenAPI, {
|
|
3309
|
+
method: 'GET',
|
|
3310
|
+
url: '/api/v1/{region}/dashboard/expenses',
|
|
3311
|
+
path: {
|
|
3312
|
+
region: data.region
|
|
3313
|
+
},
|
|
3314
|
+
query: {
|
|
3315
|
+
groupBy: data.groupBy,
|
|
3316
|
+
period: data.period,
|
|
3317
|
+
flow: data.flow
|
|
3318
|
+
},
|
|
3319
|
+
errors: {
|
|
3320
|
+
400: 'Invalid groupBy or period',
|
|
3321
|
+
401: 'User not authenticated'
|
|
3322
|
+
}
|
|
3323
|
+
});
|
|
3324
|
+
}
|
|
3325
|
+
}
|
|
3326
|
+
|
|
3327
|
+
export class InvestmentService {
|
|
3328
|
+
/**
|
|
3329
|
+
* Get per-holding unrealized + realized P&L
|
|
3330
|
+
* Average-cost unrealized P&L per account × commodity, plus cumulative realized P&L on sold lots (method = FIFO | average, default average).
|
|
3331
|
+
* @param data The data for the request.
|
|
3332
|
+
* @param data.region Region code for tenant context
|
|
3333
|
+
* @param data.asOf As-of date (ISO 8601), defaults to today
|
|
3334
|
+
* @param data.accountId Scope to a single account
|
|
3335
|
+
* @param data.method Realized-P&L lot-matching method (default average). Does not affect the average-cost unrealized basis.
|
|
3336
|
+
* @returns HoldingPnlResponseDto Holding P&L retrieved successfully
|
|
3337
|
+
* @throws ApiError
|
|
3338
|
+
*/
|
|
3339
|
+
public static holdingPnlControllerGetHoldingPnl(
|
|
3340
|
+
data: HoldingPnlControllerGetHoldingPnlData
|
|
3341
|
+
): CancelablePromise<HoldingPnlControllerGetHoldingPnlResponse> {
|
|
3342
|
+
return __request(OpenAPI, {
|
|
3343
|
+
method: 'GET',
|
|
3344
|
+
url: '/api/v1/{region}/investment/holdings/pnl',
|
|
3345
|
+
path: {
|
|
3346
|
+
region: data.region
|
|
3347
|
+
},
|
|
3348
|
+
query: {
|
|
3349
|
+
asOf: data.asOf,
|
|
3350
|
+
accountId: data.accountId,
|
|
3351
|
+
method: data.method
|
|
3352
|
+
},
|
|
3353
|
+
errors: {
|
|
3354
|
+
400: 'Invalid asOf format/value/future date, invalid accountId format, or unsupported method',
|
|
3355
|
+
401: 'User not authenticated'
|
|
3356
|
+
}
|
|
3357
|
+
});
|
|
3358
|
+
}
|
|
3359
|
+
}
|
|
3360
|
+
|
|
3361
|
+
export class BeanPricesService {
|
|
3362
|
+
/**
|
|
3363
|
+
* Create a new price
|
|
3364
|
+
* Creates a new price entry for the authenticated user
|
|
3365
|
+
* @param data The data for the request.
|
|
3366
|
+
* @param data.region Region code for tenant context
|
|
3367
|
+
* @param data.requestBody
|
|
3368
|
+
* @returns PriceResponseDto Price created successfully
|
|
3369
|
+
* @throws ApiError
|
|
3370
|
+
*/
|
|
3371
|
+
public static priceControllerCreate(
|
|
3372
|
+
data: PriceControllerCreateData
|
|
3373
|
+
): CancelablePromise<PriceControllerCreateResponse> {
|
|
3374
|
+
return __request(OpenAPI, {
|
|
3375
|
+
method: 'POST',
|
|
3376
|
+
url: '/api/v1/{region}/bean/prices',
|
|
3377
|
+
path: {
|
|
3378
|
+
region: data.region
|
|
3379
|
+
},
|
|
3380
|
+
body: data.requestBody,
|
|
3381
|
+
mediaType: 'application/json',
|
|
3382
|
+
errors: {
|
|
3383
|
+
404: 'Currency or quoteCurrency commodity not found',
|
|
3384
|
+
409: 'Price already exists for this currency pair and date'
|
|
3385
|
+
}
|
|
3386
|
+
});
|
|
3387
|
+
}
|
|
3388
|
+
|
|
3389
|
+
/**
|
|
3390
|
+
* List user prices
|
|
3391
|
+
* Returns all price entries for the authenticated user with optional filtering
|
|
3392
|
+
* @param data The data for the request.
|
|
3393
|
+
* @param data.region Region code for tenant context
|
|
3394
|
+
* @param data.currency Filter by currency (e.g., BTC, AAPL, USD)
|
|
3395
|
+
* @param data.quoteCurrency Filter by quote currency (pricing currency, e.g., USD, CNY)
|
|
3396
|
+
* @param data.dateFrom Filter prices from this date (ISO 8601 format)
|
|
3397
|
+
* @param data.dateTo Filter prices to this date (ISO 8601 format)
|
|
3398
|
+
* @param data.search Search term for currency or quoteCurrency (case-insensitive partial match)
|
|
3399
|
+
* @param data.page Page number for pagination (default: 1)
|
|
3400
|
+
* @param data.limit Number of items per page (default: 20, max: 100)
|
|
3401
|
+
* @returns PriceListResponseDto Prices retrieved successfully
|
|
3402
|
+
* @throws ApiError
|
|
3403
|
+
*/
|
|
3404
|
+
public static priceControllerFindAll(
|
|
3405
|
+
data: PriceControllerFindAllData
|
|
3406
|
+
): CancelablePromise<PriceControllerFindAllResponse> {
|
|
3407
|
+
return __request(OpenAPI, {
|
|
3408
|
+
method: 'GET',
|
|
3409
|
+
url: '/api/v1/{region}/bean/prices',
|
|
3410
|
+
path: {
|
|
3411
|
+
region: data.region
|
|
3412
|
+
},
|
|
3413
|
+
query: {
|
|
3414
|
+
currency: data.currency,
|
|
3415
|
+
quoteCurrency: data.quoteCurrency,
|
|
3416
|
+
dateFrom: data.dateFrom,
|
|
3417
|
+
dateTo: data.dateTo,
|
|
3418
|
+
search: data.search,
|
|
3419
|
+
page: data.page,
|
|
3420
|
+
limit: data.limit
|
|
3421
|
+
}
|
|
3422
|
+
});
|
|
3423
|
+
}
|
|
3424
|
+
|
|
3425
|
+
/**
|
|
3426
|
+
* Get price by ID
|
|
3427
|
+
* Returns a single price entry by its ID
|
|
3428
|
+
* @param data The data for the request.
|
|
3429
|
+
* @param data.id Price ID
|
|
3430
|
+
* @param data.region Region code for tenant context
|
|
3431
|
+
* @returns PriceResponseDto Price retrieved successfully
|
|
3432
|
+
* @throws ApiError
|
|
3433
|
+
*/
|
|
3434
|
+
public static priceControllerFindOne(
|
|
3435
|
+
data: PriceControllerFindOneData
|
|
3436
|
+
): CancelablePromise<PriceControllerFindOneResponse> {
|
|
3437
|
+
return __request(OpenAPI, {
|
|
3438
|
+
method: 'GET',
|
|
3439
|
+
url: '/api/v1/{region}/bean/prices/{id}',
|
|
3440
|
+
path: {
|
|
3441
|
+
id: data.id,
|
|
3442
|
+
region: data.region
|
|
3443
|
+
},
|
|
3444
|
+
errors: {
|
|
3445
|
+
404: 'Price not found'
|
|
3446
|
+
}
|
|
3447
|
+
});
|
|
3448
|
+
}
|
|
3449
|
+
|
|
3450
|
+
/**
|
|
3451
|
+
* Update a price
|
|
3452
|
+
* Updates an existing price entry
|
|
3453
|
+
* @param data The data for the request.
|
|
3454
|
+
* @param data.id Price ID
|
|
3455
|
+
* @param data.region Region code for tenant context
|
|
3456
|
+
* @param data.requestBody
|
|
3457
|
+
* @returns PriceResponseDto Price updated successfully
|
|
3458
|
+
* @throws ApiError
|
|
3459
|
+
*/
|
|
3460
|
+
public static priceControllerUpdate(
|
|
3461
|
+
data: PriceControllerUpdateData
|
|
3462
|
+
): CancelablePromise<PriceControllerUpdateResponse> {
|
|
3463
|
+
return __request(OpenAPI, {
|
|
3464
|
+
method: 'PUT',
|
|
3465
|
+
url: '/api/v1/{region}/bean/prices/{id}',
|
|
3466
|
+
path: {
|
|
3467
|
+
id: data.id,
|
|
3468
|
+
region: data.region
|
|
3469
|
+
},
|
|
3470
|
+
body: data.requestBody,
|
|
3471
|
+
mediaType: 'application/json',
|
|
3472
|
+
errors: {
|
|
3473
|
+
404: 'Price not found',
|
|
3474
|
+
409: 'Updated price conflicts with existing price'
|
|
3475
|
+
}
|
|
3476
|
+
});
|
|
3477
|
+
}
|
|
3478
|
+
|
|
3479
|
+
/**
|
|
3480
|
+
* Delete a price
|
|
3481
|
+
* Deletes a price entry (hard delete)
|
|
3482
|
+
* @param data The data for the request.
|
|
3483
|
+
* @param data.id Price ID
|
|
3484
|
+
* @param data.region Region code for tenant context
|
|
3485
|
+
* @returns void Price deleted successfully
|
|
3486
|
+
* @throws ApiError
|
|
3487
|
+
*/
|
|
3488
|
+
public static priceControllerDelete(
|
|
3489
|
+
data: PriceControllerDeleteData
|
|
3490
|
+
): CancelablePromise<PriceControllerDeleteResponse> {
|
|
3491
|
+
return __request(OpenAPI, {
|
|
3492
|
+
method: 'DELETE',
|
|
3493
|
+
url: '/api/v1/{region}/bean/prices/{id}',
|
|
3494
|
+
path: {
|
|
3495
|
+
id: data.id,
|
|
3496
|
+
region: data.region
|
|
3497
|
+
},
|
|
3498
|
+
errors: {
|
|
3499
|
+
404: 'Price not found'
|
|
3500
|
+
}
|
|
3501
|
+
});
|
|
3502
|
+
}
|
|
3503
|
+
|
|
3504
|
+
/**
|
|
3505
|
+
* Bulk create prices
|
|
3506
|
+
* Creates multiple price entries at once (skips duplicates)
|
|
3507
|
+
* @param data The data for the request.
|
|
3508
|
+
* @param data.region Region code for tenant context
|
|
3509
|
+
* @param data.requestBody
|
|
3510
|
+
* @returns PriceResponseDto Prices created successfully
|
|
3511
|
+
* @throws ApiError
|
|
3512
|
+
*/
|
|
3513
|
+
public static priceControllerBulkCreate(
|
|
3514
|
+
data: PriceControllerBulkCreateData
|
|
3515
|
+
): CancelablePromise<PriceControllerBulkCreateResponse> {
|
|
3516
|
+
return __request(OpenAPI, {
|
|
3517
|
+
method: 'POST',
|
|
3518
|
+
url: '/api/v1/{region}/bean/prices/bulk',
|
|
3519
|
+
path: {
|
|
3520
|
+
region: data.region
|
|
3521
|
+
},
|
|
3522
|
+
body: data.requestBody,
|
|
3523
|
+
mediaType: 'application/json'
|
|
3524
|
+
});
|
|
3525
|
+
}
|
|
3032
3526
|
}
|
|
3033
3527
|
|
|
3034
3528
|
export class ReportingService {
|
|
@@ -3072,6 +3566,42 @@ export class ReportingService {
|
|
|
3072
3566
|
});
|
|
3073
3567
|
}
|
|
3074
3568
|
|
|
3569
|
+
/**
|
|
3570
|
+
* Get cash-flow trends
|
|
3571
|
+
*
|
|
3572
|
+
* Monthly income / expense / netSavings over a fixed N-month window
|
|
3573
|
+
* (current month + N−1 prior). Missing months are zero-filled (flow metric).
|
|
3574
|
+
*
|
|
3575
|
+
* **Parameters:**
|
|
3576
|
+
* - `period`: 1m | 3m | 6m | 1y (default 6m)
|
|
3577
|
+
* - `granularity`: accepted for API symmetry; v1 returns month buckets
|
|
3578
|
+
*
|
|
3579
|
+
* @param data The data for the request.
|
|
3580
|
+
* @param data.region Region code for tenant context
|
|
3581
|
+
* @param data.period Time period
|
|
3582
|
+
* @param data.granularity Data granularity (accepted for API symmetry; v1 returns month buckets)
|
|
3583
|
+
* @returns CashFlowTrendsResponseDto Cash-flow trends retrieved successfully
|
|
3584
|
+
* @throws ApiError
|
|
3585
|
+
*/
|
|
3586
|
+
public static reportingControllerGetCashFlowTrends(
|
|
3587
|
+
data: ReportingControllerGetCashFlowTrendsData
|
|
3588
|
+
): CancelablePromise<ReportingControllerGetCashFlowTrendsResponse> {
|
|
3589
|
+
return __request(OpenAPI, {
|
|
3590
|
+
method: 'GET',
|
|
3591
|
+
url: '/api/v1/{region}/reporting/cash-flow/trends',
|
|
3592
|
+
path: {
|
|
3593
|
+
region: data.region
|
|
3594
|
+
},
|
|
3595
|
+
query: {
|
|
3596
|
+
period: data.period,
|
|
3597
|
+
granularity: data.granularity
|
|
3598
|
+
},
|
|
3599
|
+
errors: {
|
|
3600
|
+
401: 'User not authenticated'
|
|
3601
|
+
}
|
|
3602
|
+
});
|
|
3603
|
+
}
|
|
3604
|
+
|
|
3075
3605
|
/**
|
|
3076
3606
|
* Generate portfolio snapshot
|
|
3077
3607
|
*
|