@firela/api-types 0.0.0-canary.ce7c9749 → 0.0.0-canary.d190ee29

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.
@@ -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,
@@ -288,7 +291,11 @@ import type {
288
291
  HealthControllerResetCircuitBreakerData,
289
292
  HealthControllerResetCircuitBreakerResponse,
290
293
  HealthControllerGetMetricsResponse,
291
- InfoControllerGetInfoResponse
294
+ InfoControllerGetInfoResponse,
295
+ SymbolControllerSearchData,
296
+ SymbolControllerSearchResponse,
297
+ SymbolControllerGetQuoteData,
298
+ SymbolControllerGetQuoteResponse
292
299
  } from './types.gen';
293
300
 
294
301
  export class BeanAccountsService {
@@ -407,7 +414,7 @@ export class BeanAccountsService {
407
414
 
408
415
  /**
409
416
  * Delete account
410
- * Deletes an account (only if no transactions)
417
+ * Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
411
418
  * @param data The data for the request.
412
419
  * @param data.id Account UUID
413
420
  * @param data.region Region code for tenant context
@@ -426,7 +433,7 @@ export class BeanAccountsService {
426
433
  },
427
434
  errors: {
428
435
  404: 'Account not found',
429
- 409: 'Account has transactions and cannot be deleted'
436
+ 409: 'Account has active transactions and cannot be deleted'
430
437
  }
431
438
  });
432
439
  }
@@ -2344,7 +2351,7 @@ export class UsersService {
2344
2351
  * Get current authenticated user
2345
2352
  * @param data The data for the request.
2346
2353
  * @param data.acceptLanguage
2347
- * @returns unknown User retrieved successfully
2354
+ * @returns UserResponseDto User retrieved successfully
2348
2355
  * @throws ApiError
2349
2356
  */
2350
2357
  public static userControllerGetUser(
@@ -2851,6 +2858,34 @@ export class BeanTransactionRulesService {
2851
2858
  }
2852
2859
  }
2853
2860
 
2861
+ export class BeanCategoryCatalogService {
2862
+ /**
2863
+ * List category catalog for a region
2864
+ * 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.
2865
+ * @param data The data for the request.
2866
+ * @param data.region Region code for tenant context
2867
+ * @param data.scenario Filter by scenario
2868
+ * @param data.routeBearing Filter by routeBearing (entity-router route() consumes it)
2869
+ * @returns CategoryCatalogListResponseDto Category catalog retrieved successfully
2870
+ * @throws ApiError
2871
+ */
2872
+ public static categoryCatalogControllerList(
2873
+ data: CategoryCatalogControllerListData
2874
+ ): CancelablePromise<CategoryCatalogControllerListResponse> {
2875
+ return __request(OpenAPI, {
2876
+ method: 'GET',
2877
+ url: '/api/v1/{region}/bean/categories',
2878
+ path: {
2879
+ region: data.region
2880
+ },
2881
+ query: {
2882
+ scenario: data.scenario,
2883
+ routeBearing: data.routeBearing
2884
+ }
2885
+ });
2886
+ }
2887
+ }
2888
+
2854
2889
  export class LifeEventsService {
2855
2890
  /**
2856
2891
  * Create a new life event
@@ -3726,13 +3761,20 @@ export class BeanPlatformsService {
3726
3761
 
3727
3762
  /**
3728
3763
  * Get platform list for current user
3764
+ * @param data The data for the request.
3765
+ * @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").
3729
3766
  * @returns PlatformListItemDto List of platforms with user binding status
3730
3767
  * @throws ApiError
3731
3768
  */
3732
- public static platformControllerGetPlatformList(): CancelablePromise<PlatformControllerGetPlatformListResponse> {
3769
+ public static platformControllerGetPlatformList(
3770
+ data: PlatformControllerGetPlatformListData = {}
3771
+ ): CancelablePromise<PlatformControllerGetPlatformListResponse> {
3733
3772
  return __request(OpenAPI, {
3734
3773
  method: 'GET',
3735
- url: '/api/v1/bean/platforms/list'
3774
+ url: '/api/v1/bean/platforms/list',
3775
+ query: {
3776
+ region: data.region
3777
+ }
3736
3778
  });
3737
3779
  }
3738
3780
 
@@ -3740,7 +3782,7 @@ export class BeanPlatformsService {
3740
3782
  * Match platforms by name or alias
3741
3783
  * @param data The data for the request.
3742
3784
  * @param data.q Search query — Chinese name, English name, or abbreviation
3743
- * @param data.region Region code for category override lookup
3785
+ * @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").
3744
3786
  * @returns PlatformMatchResponseDto Matching platforms with overall match type and truncation flag
3745
3787
  * @throws ApiError
3746
3788
  */
@@ -4169,3 +4211,53 @@ export class InfoService {
4169
4211
  });
4170
4212
  }
4171
4213
  }
4214
+
4215
+ export class MarketDataService {
4216
+ /**
4217
+ * Search market symbols by name or code
4218
+ * Ranked search over the openbb catalog. Empty `q` returns [].
4219
+ * @param data The data for the request.
4220
+ * @param data.q Search term — matched against symbol and instrument name. Empty string returns [].
4221
+ * @param data.limit Maximum number of results (clamped 1..50)
4222
+ * @param data.exchange Filter by exchange code (e.g. US, HK, SS, SZ)
4223
+ * @param data.assetType Filter by OpenBB asset_type (e.g. stock, etf)
4224
+ * @returns SymbolSearchResultDto Ranked search results
4225
+ * @throws ApiError
4226
+ */
4227
+ public static symbolControllerSearch(
4228
+ data: SymbolControllerSearchData
4229
+ ): CancelablePromise<SymbolControllerSearchResponse> {
4230
+ return __request(OpenAPI, {
4231
+ method: 'GET',
4232
+ url: '/api/v1/market/symbols/search',
4233
+ query: {
4234
+ q: data.q,
4235
+ limit: data.limit,
4236
+ exchange: data.exchange,
4237
+ assetType: data.assetType
4238
+ }
4239
+ });
4240
+ }
4241
+
4242
+ /**
4243
+ * Get a market symbol quote
4244
+ * @param data The data for the request.
4245
+ * @param data.symbol
4246
+ * @returns SymbolQuoteDto Symbol quote
4247
+ * @throws ApiError
4248
+ */
4249
+ public static symbolControllerGetQuote(
4250
+ data: SymbolControllerGetQuoteData
4251
+ ): CancelablePromise<SymbolControllerGetQuoteResponse> {
4252
+ return __request(OpenAPI, {
4253
+ method: 'GET',
4254
+ url: '/api/v1/market/symbols/{symbol}/quote',
4255
+ path: {
4256
+ symbol: data.symbol
4257
+ },
4258
+ errors: {
4259
+ 404: 'Symbol not found in the openbb catalog'
4260
+ }
4261
+ });
4262
+ }
4263
+ }