@firela/api-types 0.0.0-canary.209967 → 0.0.0-canary.20e5bd10

package/dist/index.js

@@ -484,7 +484,7 @@ var BeanAccountsService = class {
    * @param data.type Filter by account type
    * @param data.status Filter by status
    * @param data.isCustom Filter by custom (user-created) accounts only
-   * @param data.search Search term for path or i18nKey
+   * @param data.search Search term for account path
    * @param data.limit Maximum number of results
    * @param data.offset Number of results to skip
    * @returns AccountListResponseDto Accounts retrieved successfully
@@ -556,7 +556,7 @@ var BeanAccountsService = class {
   }
   /**
    * Delete account
-   * Deletes an account (only if no transactions)
+   * Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
    * @param data The data for the request.
    * @param data.id Account UUID
    * @param data.region Region code for tenant context
@@ -573,7 +573,7 @@ var BeanAccountsService = class {
       },
       errors: {
         404: "Account not found",
-        409: "Account has transactions and cannot be deleted"
+        409: "Account has active transactions and cannot be deleted"
       }
     });
   }
@@ -629,11 +629,38 @@ var BeanAccountsService = class {
       }
     });
   }
+  /**
+   * Post an opening-balance transaction
+   * Posts a double-entry opening-balance transaction against Equity:Opening-Balances for an existing Assets/Liabilities account. At most one active opening balance per account.
+   * @param data The data for the request.
+   * @param data.id Account UUID
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns OpeningBalanceResultDto Opening-balance transaction created
+   * @throws ApiError
+   */
+  static accountControllerAddOpeningBalance(data) {
+    return request(OpenAPI, {
+      method: "POST",
+      url: "/api/v1/{region}/bean/accounts/{id}/opening-balance",
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: "application/json",
+      errors: {
+        404: "Account not found",
+        409: "An opening balance already exists for this account"
+      }
+    });
+  }
 };
 var BeanTransactionsService = class {
   /**
-   * Create transaction
-   * Creates a new double-entry transaction. Missing accounts are auto-created by default.
+   * @deprecated
+   * Create transaction (DEPRECATED)
+   * DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
    * @param data The data for the request.
    * @param data.region Region code for tenant context
    * @param data.requestBody Transaction data with postings
@@ -669,6 +696,7 @@ var BeanTransactionsService = class {
    * @param data.status Filter by transaction status
    * @param data.search Search in narration and payee fields (max 200 chars)
    * @param data.accountId Filter by account ID (transactions with postings to this account)
+   * @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
    * @returns TransactionListResponseDto Transaction list
    * @throws ApiError
    */
@@ -686,25 +714,93 @@ var BeanTransactionsService = class {
         dateTo: data.dateTo,
         status: data.status,
         search: data.search,
-        accountId: data.accountId
+        accountId: data.accountId,
+        category: data.category
       },
       errors: {
+        400: "Validation failed",
         401: "Authentication required"
       }
     });
   }
   /**
+   * @deprecated
+   * Batch create transactions (DEPRECATED)
+   * DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
    * @param data The data for the request.
    * @param data.region Region code for tenant context
-   * @returns unknown
+   * @param data.requestBody
+   * @returns BatchTransactionResponseDto Transactions processed
    * @throws ApiError
    */
-  static transactionController(data) {
+  static transactionControllerCreateBatch(data) {
     return request(OpenAPI, {
       method: "POST",
       url: "/api/v1/{region}/bean/transactions/batch",
       path: {
         region: data.region
+      },
+      body: data.requestBody,
+      mediaType: "application/json",
+      errors: {
+        400: "Invalid input",
+        401: "Authentication required"
+      }
+    });
+  }
+  /**
+   * Correct (supersede) a transaction
+   * Atomically voids the original (SUPERSEDED) and creates a replacement through the full validation pipeline.
+   * @param data The data for the request.
+   * @param data.id Original transaction ID to correct
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns TransactionDetailDto Corrected transaction created
+   * @throws ApiError
+   */
+  static transactionControllerCorrect(data) {
+    return request(OpenAPI, {
+      method: "POST",
+      url: "/api/v1/{region}/bean/transactions/{id}/correct",
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: "application/json",
+      errors: {
+        404: "Original transaction not found",
+        409: "Original no longer ACTIVE (concurrent modification)",
+        422: "Pipeline validation failed (does not balance, invalid accounts)"
+      }
+    });
+  }
+  /**
+   * Suggest transaction tags
+   * Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.q Prefix match, case-insensitive (max 50 chars)
+   * @param data.sort usage (default) or name
+   * @param data.limit Max suggestions (1-100, default 10)
+   * @returns TagSuggestionsResponseDto Tag suggestions
+   * @throws ApiError
+   */
+  static transactionControllerSuggestTags(data) {
+    return request(OpenAPI, {
+      method: "GET",
+      url: "/api/v1/{region}/bean/transactions/tags",
+      path: {
+        region: data.region
+      },
+      query: {
+        q: data.q,
+        sort: data.sort,
+        limit: data.limit
+      },
+      errors: {
+        400: "Validation failed",
+        401: "Authentication required"
       }
     });
   }
@@ -759,17 +855,26 @@ var BeanTransactionsService = class {
     });
   }
   /**
+   * Void transaction
+   * Soft-deletes a transaction by marking it as VOIDED
    * @param data The data for the request.
+   * @param data.id Transaction ID
    * @param data.region Region code for tenant context
-   * @returns void
+   * @returns void Transaction voided successfully
    * @throws ApiError
    */
-  static transactionController1(data) {
+  static transactionControllerDelete(data) {
     return request(OpenAPI, {
       method: "DELETE",
       url: "/api/v1/{region}/bean/transactions/{id}",
       path: {
+        id: data.id,
         region: data.region
+      },
+      errors: {
+        400: "Transaction already voided",
+        401: "Authentication required",
+        404: "Transaction not found"
       }
     });
   }
@@ -779,8 +884,8 @@ var BeanBalancesService = class {
    * Query account balance
    * Calculate account balance at a specific date for a single currency
    * @param data The data for the request.
-   * @param data.account Account name (e.g., "Assets:Bank:Checking")
-   * @param data.region Region code (cn, us, de)
+   * @param data.account Account name (e.g., "Assets:Checking")
+   * @param data.region Region code for tenant context
    * @param data.date Date to calculate balance at (ISO 8601 format)
    * @param data.currency Currency to query (e.g., "USD", "CNY")
    * @returns BalanceResponseDto Balance calculated successfully
@@ -808,7 +913,7 @@ var BeanBalancesService = class {
    * Query multi-currency account balance
    * Calculate account balances for all currencies at a specific date
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
+   * @param data.region Region code for tenant context
    * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
    * @throws ApiError
    */
@@ -828,17 +933,26 @@ var BeanBalancesService = class {
 };
 var BeanCommoditiesService = class {
   /**
+   * Create a new commodity
+   * Creates a new commodity definition for the authenticated user
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
-   * @returns unknown
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns CommodityResponseDto Commodity created successfully
    * @throws ApiError
    */
-  static commodityController(data) {
+  static commodityControllerCreate(data) {
     return request(OpenAPI, {
       method: "POST",
       url: "/api/v1/{region}/bean/commodities",
       path: {
         region: data.region
+      },
+      body: data.requestBody,
+      mediaType: "application/json",
+      errors: {
+        400: "Invalid input data",
+        409: "Commodity already exists"
       }
     });
   }
@@ -846,7 +960,7 @@ var BeanCommoditiesService = class {
    * List user commodities
    * Returns all commodity definitions for the authenticated user with optional filtering
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
+   * @param data.region Region code for tenant context
    * @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
    * @param data.symbol Filter by exact symbol match
    * @returns CommodityListResponseDto Commodities retrieved successfully
@@ -870,7 +984,7 @@ var BeanCommoditiesService = class {
    * Returns a specific commodity definition by its symbol
    * @param data The data for the request.
    * @param data.symbol Commodity symbol
-   * @param data.region Region code (cn, us, de)
+   * @param data.region Region code for tenant context
    * @returns CommodityResponseDto Commodity retrieved successfully
    * @throws ApiError
    */
@@ -888,57 +1002,81 @@ var BeanCommoditiesService = class {
     });
   }
   /**
+   * Update commodity
+   * Updates an existing commodity definition. Symbol cannot be changed.
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
-   * @returns unknown
+   * @param data.symbol Commodity symbol
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns CommodityResponseDto Commodity updated successfully
    * @throws ApiError
    */
-  static commodityController1(data) {
+  static commodityControllerUpdate(data) {
     return request(OpenAPI, {
       method: "PUT",
       url: "/api/v1/{region}/bean/commodities/{symbol}",
       path: {
+        symbol: data.symbol,
         region: data.region
+      },
+      body: data.requestBody,
+      mediaType: "application/json",
+      errors: {
+        400: "Invalid input data",
+        404: "Commodity not found"
       }
     });
   }
   /**
+   * Delete commodity
+   * Deletes a commodity definition
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
-   * @returns void
+   * @param data.symbol Commodity symbol
+   * @param data.region Region code for tenant context
+   * @returns void Commodity deleted successfully
    * @throws ApiError
    */
-  static commodityController2(data) {
+  static commodityControllerDelete(data) {
     return request(OpenAPI, {
       method: "DELETE",
       url: "/api/v1/{region}/bean/commodities/{symbol}",
       path: {
+        symbol: data.symbol,
         region: data.region
+      },
+      errors: {
+        404: "Commodity not found"
       }
     });
   }
   /**
+   * Ensure commodity exists
+   * Gets existing commodity or creates it with automatic initialization from OpenBB
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
-   * @returns unknown
+   * @param data.symbol Commodity symbol
+   * @param data.region Region code for tenant context
+   * @returns CommodityResponseDto Commodity retrieved or created
    * @throws ApiError
    */
-  static commodityController3(data) {
+  static commodityControllerGetOrCreate(data) {
     return request(OpenAPI, {
       method: "POST",
       url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
       path: {
+        symbol: data.symbol,
         region: data.region
       }
     });
   }
   /**
+   * Bulk create commodities
+   * Creates multiple commodities from a list of symbols, useful for initialization
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
-   * @returns unknown
+   * @param data.region Region code for tenant context
+   * @returns CommodityResponseDto Commodities created successfully
    * @throws ApiError
    */
-  static commodityController4(data) {
+  static commodityControllerBulkCreate(data) {
     return request(OpenAPI, {
       method: "POST",
       url: "/api/v1/{region}/bean/commodities/bulk",
@@ -962,6 +1100,7 @@ var ProviderSyncService = class {
    * - **simplefin**: SimpleFIN (Self-hosted)
    * - **yodlee**: Yodlee (Global)
    * - **beancount-direct**: Beancount format transactions
+   * - **parsed-bill**: Client-side parsed bill transactions
    *
    * **Processing Flow:**
    * 1. Transform raw data via provider adapter
@@ -973,7 +1112,7 @@ var ProviderSyncService = class {
    *
    * @param data The data for the request.
    * @param data.providerName Provider name
-   * @param data.region Region code
+   * @param data.region Region code for tenant context
    * @param data.requestBody
    * @returns ProviderSyncResponseDto Sync completed successfully
    * @throws ApiError
@@ -999,7 +1138,7 @@ var ProviderSyncService = class {
    * Get supported providers
    * Returns a list of all providers supported by the sync endpoint.
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
+   * @param data.region Region code for tenant context
    * @returns SupportedProvidersResponseDto List of supported providers
    * @throws ApiError
    */
@@ -1020,7 +1159,7 @@ var ProviderSyncService = class {
    * Returns whether a specific provider is supported.
    * @param data The data for the request.
    * @param data.providerName Provider name to check
-   * @param data.region Region code (cn, us, de)
+   * @param data.region Region code for tenant context
    * @returns unknown Provider support status
    * @throws ApiError
    */
@@ -1041,18 +1180,13 @@ var ProviderSyncService = class {
 var HealthService = class {
   /**
    * Basic health check for K8s/load balancer probes
-   * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
    * @returns unknown Service is healthy
    * @throws ApiError
    */
-  static healthControllerGetHealth(data) {
+  static healthControllerGetHealth() {
     return request(OpenAPI, {
       method: "GET",
       url: "/api/v1/health",
-      path: {
-        region: data.region
-      },
       errors: {
         503: "Service unavailable"
       }
@@ -1060,37 +1194,41 @@ var HealthService = class {
   }
   /**
    * Check database connection health
-   * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
    * @returns unknown Database is healthy
    * @throws ApiError
    */
-  static healthControllerCheckDatabase(data) {
+  static healthControllerCheckDatabase() {
     return request(OpenAPI, {
       method: "GET",
       url: "/api/v1/health/database",
-      path: {
-        region: data.region
-      },
       errors: {
         503: "Database unavailable"
       }
     });
   }
+  /**
+   * Check OpenBB schema status
+   * @returns unknown OpenBB status
+   * @throws ApiError
+   */
+  static healthControllerCheckOpenBb() {
+    return request(OpenAPI, {
+      method: "GET",
+      url: "/api/v1/health/openbb",
+      errors: {
+        503: "OpenBB unavailable"
+      }
+    });
+  }
   /**
    * Check Redis connection health
-   * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
    * @returns unknown Redis is healthy
    * @throws ApiError
    */
-  static healthControllerCheckRedis(data) {
+  static healthControllerCheckRedis() {
     return request(OpenAPI, {
       method: "GET",
       url: "/api/v1/health/redis",
-      path: {
-        region: data.region
-      },
       errors: {
         503: "Redis unavailable"
       }
@@ -1098,18 +1236,13 @@ var HealthService = class {
   }
   /**
    * Get status of all circuit breakers
-   * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
    * @returns unknown Circuit breaker status
    * @throws ApiError
    */
-  static healthControllerGetCircuitBreakersHealth(data) {
+  static healthControllerGetCircuitBreakersHealth() {
     return request(OpenAPI, {
       method: "GET",
       url: "/api/v1/health/circuit-breakers",
-      path: {
-        region: data.region
-      },
       errors: {
         401: "Unauthorized",
         500: "Internal error"
@@ -1120,7 +1253,6 @@ var HealthService = class {
    * Reset a circuit breaker to CLOSED state
    * @param data The data for the request.
    * @param data.name Circuit breaker name to reset
-   * @param data.region Region code (cn, us, de)
    * @returns unknown Circuit breaker reset successfully
    * @throws ApiError
    */
@@ -1129,8 +1261,7 @@ var HealthService = class {
       method: "POST",
       url: "/api/v1/health/circuit-breakers/{name}/reset",
       path: {
-        name: data.name,
-        region: data.region
+        name: data.name
       },
       errors: {
         401: "Unauthorized",
@@ -1140,88 +1271,18 @@ var HealthService = class {
   }
   /**
    * Get health check metrics and statistics
-   * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
    * @returns unknown Health metrics
    * @throws ApiError
    */
-  static healthControllerGetMetrics(data) {
+  static healthControllerGetMetrics() {
     return request(OpenAPI, {
       method: "GET",
       url: "/api/v1/health/metrics",
-      path: {
-        region: data.region
-      },
       errors: {
         401: "Unauthorized"
       }
     });
   }
-  /**
-   * Check health of a specific data enhancer
-   * @param data The data for the request.
-   * @param data.name Data enhancer name
-   * @param data.region Region code (cn, us, de)
-   * @returns unknown Data enhancer is healthy
-   * @throws ApiError
-   */
-  static healthControllerGetHealthOfDataEnhancer(data) {
-    return request(OpenAPI, {
-      method: "GET",
-      url: "/api/v1/health/data-enhancer/{name}",
-      path: {
-        name: data.name,
-        region: data.region
-      },
-      errors: {
-        401: "Unauthorized",
-        503: "Data enhancer unavailable"
-      }
-    });
-  }
-  /**
-   * Check health of all data providers
-   * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
-   * @returns unknown Data providers health status
-   * @throws ApiError
-   */
-  static healthControllerCheckDataProviders(data) {
-    return request(OpenAPI, {
-      method: "GET",
-      url: "/api/v1/health/data-providers",
-      path: {
-        region: data.region
-      },
-      errors: {
-        401: "Unauthorized",
-        503: "Data providers check failed"
-      }
-    });
-  }
-  /**
-   * Check health of a specific data provider
-   * @param data The data for the request.
-   * @param data.dataSource Data source identifier
-   * @param data.region Region code (cn, us, de)
-   * @returns unknown Data provider is healthy
-   * @throws ApiError
-   */
-  static healthControllerGetHealthOfDataProvider(data) {
-    return request(OpenAPI, {
-      method: "GET",
-      url: "/api/v1/health/data-provider/{dataSource}",
-      path: {
-        dataSource: data.dataSource,
-        region: data.region
-      },
-      errors: {
-        400: "Invalid data source",
-        401: "Unauthorized",
-        503: "Data provider unavailable"
-      }
-    });
-  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {