@firela/api-types 0.0.0-canary.9d18b250 → 0.0.0-canary.a026f79e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -337,7 +337,7 @@ export class BeanAccountsService {
337
337
  * @param data.type Filter by account type
338
338
  * @param data.status Filter by status
339
339
  * @param data.isCustom Filter by custom (user-created) accounts only
340
- * @param data.search Search term for account path
340
+ * @param data.search Search term matched against account path and user-set display name (case-insensitive)
341
341
  * @param data.limit Maximum number of results
342
342
  * @param data.offset Number of results to skip
343
343
  * @returns AccountListResponseDto Accounts retrieved successfully
@@ -533,9 +533,9 @@ export class BeanAccountsService {
533
533
  export class BeanAccountStandardsService {
534
534
  /**
535
535
  * Get account templates
536
- * Returns predefined account templates for a region. Supports filtering by account type and search term.
536
+ * Returns predefined account templates for a region. Supports filtering by account type and search term. Not-yet-open region codes return the universal-only catalog (#759).
537
537
  * @param data The data for the request.
538
- * @param data.region Region code (cn, us, de)
538
+ * @param data.region Region code (any ISO alpha-2; not-yet-open codes return the universal-only catalog)
539
539
  * @param data.type Filter by account type
540
540
  * @param data.search Search term for path, description, aliases, or localized display name
541
541
  * @returns AccountStandardListResponseDto Account templates retrieved successfully
@@ -561,7 +561,7 @@ export class BeanAccountStandardsService {
561
561
  * Get template metadata for an account path
562
562
  * Returns root type for a template path.
563
563
  * @param data The data for the request.
564
- * @param data.region Region code for tenant context
564
+ * @param data.region Region code for tenant context. Not-yet-open codes degrade to the universal-only catalog (#759)
565
565
  * @param data.path Account path to check
566
566
  * @returns TemplateMetadataResponseDto Template metadata retrieved successfully
567
567
  * @throws ApiError
@@ -583,9 +583,9 @@ export class BeanAccountStandardsService {
583
583
 
584
584
  /**
585
585
  * Get available regions with hierarchy
586
- * Returns supported regions with inheritance metadata
586
+ * Returns the full region catalog (every ISO 3166-1 entry) with an 'open' flag and inheritance metadata (#759)
587
587
  * @param data The data for the request.
588
- * @param data.region Region code for tenant context
588
+ * @param data.region Region code for tenant context. Not-yet-open codes degrade to the universal-only catalog (#759)
589
589
  * @returns RegionsMetadataResponseDto Regions metadata retrieved successfully
590
590
  * @throws ApiError
591
591
  */
@@ -1381,7 +1381,7 @@ export class AdminPayeeProfilesService {
1381
1381
  * Removes verification status by setting verifiedAt to null.
1382
1382
  * @param data The data for the request.
1383
1383
  * @param data.id Payee profile ID (UUID)
1384
- * @returns PayeeProfileResponseDto Payee profile unverified successfully
1384
+ * @returns void Payee profile unverified successfully
1385
1385
  * @throws ApiError
1386
1386
  */
1387
1387
  public static payeeProfileAdminControllerUnverify(
@@ -2454,7 +2454,7 @@ export class ExpectedTransactionsService {
2454
2454
  * @param data The data for the request.
2455
2455
  * @param data.id Expected transaction ID
2456
2456
  * @param data.region Region code for tenant context
2457
- * @returns ExpectedTransactionResponseDto Skip undone successfully
2457
+ * @returns void Skip undone successfully
2458
2458
  * @throws ApiError
2459
2459
  */
2460
2460
  public static expectedTransactionControllerUndoSkip(
@@ -2510,7 +2510,7 @@ export class ExpectedTransactionsService {
2510
2510
  * @param data The data for the request.
2511
2511
  * @param data.id Expected transaction ID
2512
2512
  * @param data.region Region code for tenant context
2513
- * @returns unknown Match removed successfully
2513
+ * @returns void Match removed successfully
2514
2514
  * @throws ApiError
2515
2515
  */
2516
2516
  public static expectedTransactionControllerUnmatch(
@@ -2867,7 +2867,7 @@ export class BeanTransactionRulesService {
2867
2867
  export class BeanCategoryCatalogService {
2868
2868
  /**
2869
2869
  * List category catalog for a region
2870
- * Returns the region-scoped category slugs (expense/income/investment/banking/transfer/payment) for the NLP result picker. CN-exclusive payment instruments (huabei/baitiao) appear only under /cn.
2870
+ * Returns the region-scoped category slugs (expense/income/investment/banking/transfer/payment) for the NLP result picker, each with the categoryAccount paths the region-enabled system rules map it to (#816). CN-exclusive payment instruments (huabei/baitiao) appear only under /cn.
2871
2871
  * @param data The data for the request.
2872
2872
  * @param data.region Region code for tenant context
2873
2873
  * @param data.scenario Filter by scenario
@@ -3071,7 +3071,7 @@ export class OnboardingService {
3071
3071
  /**
3072
3072
  * Bootstrap core accounts + register asset accounts with opening balances (ADR-0113)
3073
3073
  * @param data The data for the request.
3074
- * @param data.region Region code for tenant context
3074
+ * @param data.region Region code for tenant context. Not-yet-open codes are accepted: the universal catalog backs onboarding regardless of region (#759)
3075
3075
  * @param data.requestBody
3076
3076
  * @returns unknown Onboarding bootstrap result.
3077
3077
  * @throws ApiError
@@ -3204,7 +3204,7 @@ export class BeanExportService {
3204
3204
  /**
3205
3205
  * Export Beancount ledger as ZIP
3206
3206
  * Export all user Beancount data as a ZIP file containing ledger.beancount and yearly files in community format.
3207
- * @returns unknown
3207
+ * @returns binary ZIP archive (application/zip) streamed as an attachment
3208
3208
  * @throws ApiError
3209
3209
  */
3210
3210
  public static exportControllerExportBeancount(): CancelablePromise<ExportControllerExportBeancountResponse> {
@@ -4105,15 +4105,20 @@ export class CommunityService {
4105
4105
  }
4106
4106
  }
4107
4107
 
4108
- export class DefaultService {
4108
+ export class AdminCacheService {
4109
4109
  /**
4110
- * @returns unknown
4110
+ * Flush entire cache (L1 + L2)
4111
+ * Clears ALL cache entries across ALL namespaces and users. Use only for emergency cache corruption recovery, maintenance-window refresh, or development resets.
4112
+ * @returns unknown Cache flushed successfully
4111
4113
  * @throws ApiError
4112
4114
  */
4113
4115
  public static cacheControllerFlushCache(): CancelablePromise<CacheControllerFlushCacheResponse> {
4114
4116
  return __request(OpenAPI, {
4115
4117
  method: 'POST',
4116
- url: '/api/v1/cache/flush'
4118
+ url: '/api/v1/cache/flush',
4119
+ errors: {
4120
+ 403: 'Admin access required'
4121
+ }
4117
4122
  });
4118
4123
  }
4119
4124
  }