@firela/api-types 0.0.0-canary.feeae929 → 0.0.0-canary.ffdf0021
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 +432 -30
- package/dist/index.d.ts +432 -30
- package/dist/index.js +4 -2
- package/dist/index.mjs +4 -2
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +629 -16
- package/src/generated/services.gen.ts +80 -6
- package/src/generated/types.gen.ts +574 -30
|
@@ -193,6 +193,8 @@ import type {
|
|
|
193
193
|
TransactionRuleControllerDeleteResponse,
|
|
194
194
|
TransactionRuleControllerTestData,
|
|
195
195
|
TransactionRuleControllerTestResponse,
|
|
196
|
+
CategoryCatalogControllerListData,
|
|
197
|
+
CategoryCatalogControllerListResponse,
|
|
196
198
|
EventControllerCreateData,
|
|
197
199
|
EventControllerCreateResponse,
|
|
198
200
|
EventControllerFindAllData,
|
|
@@ -257,6 +259,7 @@ import type {
|
|
|
257
259
|
PlatformControllerFindAllResponse,
|
|
258
260
|
PlatformControllerCreateData,
|
|
259
261
|
PlatformControllerCreateResponse,
|
|
262
|
+
PlatformControllerGetPlatformListData,
|
|
260
263
|
PlatformControllerGetPlatformListResponse,
|
|
261
264
|
PlatformControllerMatchPlatformsData,
|
|
262
265
|
PlatformControllerMatchPlatformsResponse,
|
|
@@ -277,6 +280,8 @@ import type {
|
|
|
277
280
|
ApiKeysControllerCreateApiKeyResponse,
|
|
278
281
|
AuthControllerAccessTokenLoginData,
|
|
279
282
|
AuthControllerAccessTokenLoginResponse,
|
|
283
|
+
ParserContributionControllerCreateData,
|
|
284
|
+
ParserContributionControllerCreateResponse,
|
|
280
285
|
CacheControllerFlushCacheResponse,
|
|
281
286
|
ExchangeRateControllerGetExchangeRateData,
|
|
282
287
|
ExchangeRateControllerGetExchangeRateResponse,
|
|
@@ -638,7 +643,8 @@ export class BeanTransactionsService {
|
|
|
638
643
|
* @param data.status Filter by transaction status
|
|
639
644
|
* @param data.search Search in narration and payee fields (max 200 chars)
|
|
640
645
|
* @param data.accountId Filter by account ID (transactions with postings to this account)
|
|
641
|
-
* @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an
|
|
646
|
+
* @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).
|
|
647
|
+
* @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.
|
|
642
648
|
* @returns TransactionListResponseDto Transaction list
|
|
643
649
|
* @throws ApiError
|
|
644
650
|
*/
|
|
@@ -659,7 +665,8 @@ export class BeanTransactionsService {
|
|
|
659
665
|
status: data.status,
|
|
660
666
|
search: data.search,
|
|
661
667
|
accountId: data.accountId,
|
|
662
|
-
category: data.category
|
|
668
|
+
category: data.category,
|
|
669
|
+
flow: data.flow
|
|
663
670
|
},
|
|
664
671
|
errors: {
|
|
665
672
|
400: 'Validation failed',
|
|
@@ -2348,7 +2355,7 @@ export class UsersService {
|
|
|
2348
2355
|
* Get current authenticated user
|
|
2349
2356
|
* @param data The data for the request.
|
|
2350
2357
|
* @param data.acceptLanguage
|
|
2351
|
-
* @returns
|
|
2358
|
+
* @returns UserResponseDto User retrieved successfully
|
|
2352
2359
|
* @throws ApiError
|
|
2353
2360
|
*/
|
|
2354
2361
|
public static userControllerGetUser(
|
|
@@ -2855,6 +2862,34 @@ export class BeanTransactionRulesService {
|
|
|
2855
2862
|
}
|
|
2856
2863
|
}
|
|
2857
2864
|
|
|
2865
|
+
export class BeanCategoryCatalogService {
|
|
2866
|
+
/**
|
|
2867
|
+
* List category catalog for a region
|
|
2868
|
+
* Returns the region-scoped category slugs (expense/income/investment/banking/transfer/payment) for the NLP result picker. CN-exclusive payment instruments (huabei/baitiao) appear only under /cn.
|
|
2869
|
+
* @param data The data for the request.
|
|
2870
|
+
* @param data.region Region code for tenant context
|
|
2871
|
+
* @param data.scenario Filter by scenario
|
|
2872
|
+
* @param data.routeBearing Filter by routeBearing (entity-router route() consumes it)
|
|
2873
|
+
* @returns CategoryCatalogListResponseDto Category catalog retrieved successfully
|
|
2874
|
+
* @throws ApiError
|
|
2875
|
+
*/
|
|
2876
|
+
public static categoryCatalogControllerList(
|
|
2877
|
+
data: CategoryCatalogControllerListData
|
|
2878
|
+
): CancelablePromise<CategoryCatalogControllerListResponse> {
|
|
2879
|
+
return __request(OpenAPI, {
|
|
2880
|
+
method: 'GET',
|
|
2881
|
+
url: '/api/v1/{region}/bean/categories',
|
|
2882
|
+
path: {
|
|
2883
|
+
region: data.region
|
|
2884
|
+
},
|
|
2885
|
+
query: {
|
|
2886
|
+
scenario: data.scenario,
|
|
2887
|
+
routeBearing: data.routeBearing
|
|
2888
|
+
}
|
|
2889
|
+
});
|
|
2890
|
+
}
|
|
2891
|
+
}
|
|
2892
|
+
|
|
2858
2893
|
export class LifeEventsService {
|
|
2859
2894
|
/**
|
|
2860
2895
|
* Create a new life event
|
|
@@ -3730,13 +3765,20 @@ export class BeanPlatformsService {
|
|
|
3730
3765
|
|
|
3731
3766
|
/**
|
|
3732
3767
|
* Get platform list for current user
|
|
3768
|
+
* @param data The data for the request.
|
|
3769
|
+
* @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").
|
|
3733
3770
|
* @returns PlatformListItemDto List of platforms with user binding status
|
|
3734
3771
|
* @throws ApiError
|
|
3735
3772
|
*/
|
|
3736
|
-
public static platformControllerGetPlatformList(
|
|
3773
|
+
public static platformControllerGetPlatformList(
|
|
3774
|
+
data: PlatformControllerGetPlatformListData = {}
|
|
3775
|
+
): CancelablePromise<PlatformControllerGetPlatformListResponse> {
|
|
3737
3776
|
return __request(OpenAPI, {
|
|
3738
3777
|
method: 'GET',
|
|
3739
|
-
url: '/api/v1/bean/platforms/list'
|
|
3778
|
+
url: '/api/v1/bean/platforms/list',
|
|
3779
|
+
query: {
|
|
3780
|
+
region: data.region
|
|
3781
|
+
}
|
|
3740
3782
|
});
|
|
3741
3783
|
}
|
|
3742
3784
|
|
|
@@ -3744,7 +3786,7 @@ export class BeanPlatformsService {
|
|
|
3744
3786
|
* Match platforms by name or alias
|
|
3745
3787
|
* @param data The data for the request.
|
|
3746
3788
|
* @param data.q Search query — Chinese name, English name, or abbreviation
|
|
3747
|
-
* @param data.region Region code
|
|
3789
|
+
* @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").
|
|
3748
3790
|
* @returns PlatformMatchResponseDto Matching platforms with overall match type and truncation flag
|
|
3749
3791
|
* @throws ApiError
|
|
3750
3792
|
*/
|
|
@@ -4004,6 +4046,38 @@ export class AuthService {
|
|
|
4004
4046
|
}
|
|
4005
4047
|
}
|
|
4006
4048
|
|
|
4049
|
+
export class CommunityService {
|
|
4050
|
+
/**
|
|
4051
|
+
* Relay a sanitized parser-contribution payload
|
|
4052
|
+
* 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).
|
|
4053
|
+
* @param data The data for the request.
|
|
4054
|
+
* @param data.region Region code for tenant context (routing only; the institution region rides in the payload meta)
|
|
4055
|
+
* @param data.requestBody
|
|
4056
|
+
* @returns ParserContributionRelayResponseDto Issue created by the bot
|
|
4057
|
+
* @throws ApiError
|
|
4058
|
+
*/
|
|
4059
|
+
public static parserContributionControllerCreate(
|
|
4060
|
+
data: ParserContributionControllerCreateData
|
|
4061
|
+
): CancelablePromise<ParserContributionControllerCreateResponse> {
|
|
4062
|
+
return __request(OpenAPI, {
|
|
4063
|
+
method: 'POST',
|
|
4064
|
+
url: '/api/v1/{region}/community/parser-contributions',
|
|
4065
|
+
path: {
|
|
4066
|
+
region: data.region
|
|
4067
|
+
},
|
|
4068
|
+
body: data.requestBody,
|
|
4069
|
+
mediaType: 'application/json',
|
|
4070
|
+
errors: {
|
|
4071
|
+
401: 'Unauthorized',
|
|
4072
|
+
422: 'Validation failed (institution slug, empty samples, row/cell size limits)',
|
|
4073
|
+
429: 'Rate limited (5 submissions per user per hour)',
|
|
4074
|
+
501: 'Relay not configured on this deployment — clients fall back to the clipboard flow',
|
|
4075
|
+
502: 'GitHub bot failure (upstream), safe to retry'
|
|
4076
|
+
}
|
|
4077
|
+
});
|
|
4078
|
+
}
|
|
4079
|
+
}
|
|
4080
|
+
|
|
4007
4081
|
export class DefaultService {
|
|
4008
4082
|
/**
|
|
4009
4083
|
* @returns unknown
|