@firela/api-types 0.0.0-canary.a7bda42

package/dist/generated/services.gen.d.ts

@@ -0,0 +1,313 @@
+import type { CancelablePromise } from './core/CancelablePromise';
+import type { GetHealthResponse, ListTransactionsData, ListTransactionsResponse, CreateTransactionData, CreateTransactionResponse, GetTransactionData, GetTransactionResponse, UpdateTransactionData, UpdateTransactionResponse, VoidTransactionData, VoidTransactionResponse, ListAccountsData, ListAccountsResponse, CreateAccountData, CreateAccountResponse, GetAccountData, GetAccountResponse, UpdateAccountData, UpdateAccountResponse, DeleteAccountData, DeleteAccountResponse, CloseAccountData, CloseAccountResponse, ReopenAccountData, ReopenAccountResponse, ListCommoditiesData, ListCommoditiesResponse, CreateCommodityData, CreateCommodityResponse, GetCommodityData, GetCommodityResponse, UpdateCommodityData, UpdateCommodityResponse, DeleteCommodityData, DeleteCommodityResponse, EnsureCommodityData, EnsureCommodityResponse, BulkCreateCommoditiesData, BulkCreateCommoditiesResponse, ListPricesData, ListPricesResponse, CreatePriceData, CreatePriceResponse, GetPriceData, GetPriceResponse, UpdatePriceData, UpdatePriceResponse, DeletePriceData, DeletePriceResponse, BulkCreatePricesData, BulkCreatePricesResponse, GetBalanceData, GetBalanceResponse, GetMultiCurrencyBalanceData, GetMultiCurrencyBalanceResponse } from './types.gen';
+export declare class HealthService {
+    /**
+     * Health check
+     * Returns the health status of the API service
+     * @returns HealthResponse Service is healthy
+     * @throws ApiError
+     */
+    static getHealth(): CancelablePromise<GetHealthResponse>;
+}
+export declare class TransactionService {
+    /**
+     * List transactions
+     * Retrieve a paginated list of transactions for the specified region
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.limit Maximum number of results (1-100)
+     * @param data.offset Number of items to skip
+     * @param data.dateFrom Filter from date (inclusive, ISO 8601)
+     * @param data.dateTo Filter to date (inclusive, ISO 8601)
+     * @param data.status Filter by transaction status
+     * @param data.search Search in narration and payee fields
+     * @param data.accountId Filter by account ID
+     * @returns TransactionListResponse List of transactions
+     * @throws ApiError
+     */
+    static listTransactions(data: ListTransactionsData): CancelablePromise<ListTransactionsResponse>;
+    /**
+     * Create transaction
+     * Create a new double-entry transaction.
+     *
+     * A transaction must have at least 2 postings that balance (debits = credits).
+     * The system will automatically interpolate missing amounts if possible.
+     *
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.requestBody
+     * @returns TransactionResponse Transaction created successfully
+     * @throws ApiError
+     */
+    static createTransaction(data: CreateTransactionData): CancelablePromise<CreateTransactionResponse>;
+    /**
+     * Get transaction
+     * Retrieve a specific transaction by ID with full details
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Transaction ID (CUID format)
+     * @returns TransactionDetail Transaction details
+     * @throws ApiError
+     */
+    static getTransaction(data: GetTransactionData): CancelablePromise<GetTransactionResponse>;
+    /**
+     * Update transaction metadata
+     * Update transaction metadata fields (does not change postings)
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Transaction ID (CUID format)
+     * @param data.requestBody
+     * @returns TransactionDetail Transaction updated
+     * @throws ApiError
+     */
+    static updateTransaction(data: UpdateTransactionData): CancelablePromise<UpdateTransactionResponse>;
+    /**
+     * Void transaction
+     * Mark a transaction as voided (soft delete)
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Transaction ID (CUID format)
+     * @returns void Transaction voided
+     * @throws ApiError
+     */
+    static voidTransaction(data: VoidTransactionData): CancelablePromise<VoidTransactionResponse>;
+}
+export declare class AccountService {
+    /**
+     * List accounts
+     * Retrieve all accounts for the specified region with optional filters
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.type Filter by account type
+     * @param data.status Filter by account status
+     * @param data.isCustom Filter custom accounts only
+     * @param data.search Search in path and i18nKey
+     * @param data.limit
+     * @param data.offset
+     * @returns AccountListResponse List of accounts
+     * @throws ApiError
+     */
+    static listAccounts(data: ListAccountsData): CancelablePromise<ListAccountsResponse>;
+    /**
+     * Create account
+     * Create a new Beancount account
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.requestBody
+     * @returns AccountResponse Account created
+     * @throws ApiError
+     */
+    static createAccount(data: CreateAccountData): CancelablePromise<CreateAccountResponse>;
+    /**
+     * Get account
+     * Retrieve a specific account by ID
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Account ID (UUID format)
+     * @returns AccountResponse Account details
+     * @throws ApiError
+     */
+    static getAccount(data: GetAccountData): CancelablePromise<GetAccountResponse>;
+    /**
+     * Update account
+     * Update account properties
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Account ID (UUID format)
+     * @param data.requestBody
+     * @returns AccountResponse Account updated
+     * @throws ApiError
+     */
+    static updateAccount(data: UpdateAccountData): CancelablePromise<UpdateAccountResponse>;
+    /**
+     * Delete account
+     * Delete an account (only if no postings reference it)
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Account ID (UUID format)
+     * @returns void Account deleted
+     * @throws ApiError
+     */
+    static deleteAccount(data: DeleteAccountData): CancelablePromise<DeleteAccountResponse>;
+    /**
+     * Close account
+     * Mark an account as closed
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Account ID (UUID format)
+     * @returns AccountResponse Account closed
+     * @throws ApiError
+     */
+    static closeAccount(data: CloseAccountData): CancelablePromise<CloseAccountResponse>;
+    /**
+     * Reopen account
+     * Reopen a previously closed account
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Account ID (UUID format)
+     * @returns AccountResponse Account reopened
+     * @throws ApiError
+     */
+    static reopenAccount(data: ReopenAccountData): CancelablePromise<ReopenAccountResponse>;
+}
+export declare class CommodityService {
+    /**
+     * List commodities
+     * Retrieve all commodity definitions for the region
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @returns CommodityListResponse List of commodities
+     * @throws ApiError
+     */
+    static listCommodities(data: ListCommoditiesData): CancelablePromise<ListCommoditiesResponse>;
+    /**
+     * Create commodity
+     * Create a new commodity/currency definition
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.requestBody
+     * @returns CommodityResponse Commodity created
+     * @throws ApiError
+     */
+    static createCommodity(data: CreateCommodityData): CancelablePromise<CreateCommodityResponse>;
+    /**
+     * Get commodity
+     * Retrieve a specific commodity by symbol
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.symbol Commodity symbol (e.g., "USD", "AAPL")
+     * @returns CommodityResponse Commodity details
+     * @throws ApiError
+     */
+    static getCommodity(data: GetCommodityData): CancelablePromise<GetCommodityResponse>;
+    /**
+     * Update commodity
+     * Update commodity properties
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.symbol Commodity symbol (e.g., "USD", "AAPL")
+     * @param data.requestBody
+     * @returns CommodityResponse Commodity updated
+     * @throws ApiError
+     */
+    static updateCommodity(data: UpdateCommodityData): CancelablePromise<UpdateCommodityResponse>;
+    /**
+     * Delete commodity
+     * Delete a commodity definition
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.symbol Commodity symbol (e.g., "USD", "AAPL")
+     * @returns void Commodity deleted
+     * @throws ApiError
+     */
+    static deleteCommodity(data: DeleteCommodityData): CancelablePromise<DeleteCommodityResponse>;
+    /**
+     * Get or create commodity
+     * Get existing commodity or create if not exists
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.symbol Commodity symbol (e.g., "USD", "AAPL")
+     * @param data.requestBody
+     * @returns CommodityResponse Commodity found or created
+     * @throws ApiError
+     */
+    static ensureCommodity(data: EnsureCommodityData): CancelablePromise<EnsureCommodityResponse>;
+    /**
+     * Bulk create commodities
+     * Create multiple commodities at once
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.requestBody
+     * @returns CommodityListResponse Commodities created
+     * @throws ApiError
+     */
+    static bulkCreateCommodities(data: BulkCreateCommoditiesData): CancelablePromise<BulkCreateCommoditiesResponse>;
+}
+export declare class PriceService {
+    /**
+     * List prices
+     * Retrieve all price quotes for the region
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @returns PriceListResponse List of prices
+     * @throws ApiError
+     */
+    static listPrices(data: ListPricesData): CancelablePromise<ListPricesResponse>;
+    /**
+     * Create price
+     * Create a new price quote
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.requestBody
+     * @returns PriceResponse Price created
+     * @throws ApiError
+     */
+    static createPrice(data: CreatePriceData): CancelablePromise<CreatePriceResponse>;
+    /**
+     * Get price
+     * Retrieve a specific price quote by ID
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Price ID (UUID format)
+     * @returns PriceResponse Price details
+     * @throws ApiError
+     */
+    static getPrice(data: GetPriceData): CancelablePromise<GetPriceResponse>;
+    /**
+     * Update price
+     * Update a price quote
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Price ID (UUID format)
+     * @param data.requestBody
+     * @returns PriceResponse Price updated
+     * @throws ApiError
+     */
+    static updatePrice(data: UpdatePriceData): CancelablePromise<UpdatePriceResponse>;
+    /**
+     * Delete price
+     * Delete a price quote
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.id Price ID (UUID format)
+     * @returns void Price deleted
+     * @throws ApiError
+     */
+    static deletePrice(data: DeletePriceData): CancelablePromise<DeletePriceResponse>;
+    /**
+     * Bulk create prices
+     * Create multiple price quotes at once
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.requestBody
+     * @returns PriceListResponse Prices created
+     * @throws ApiError
+     */
+    static bulkCreatePrices(data: BulkCreatePricesData): CancelablePromise<BulkCreatePricesResponse>;
+}
+export declare class BalanceService {
+    /**
+     * Query balance
+     * Get the balance of an account in a specific currency
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.account Account path (e.g., "Assets:Bank:Checking")
+     * @param data.currency Currency code (e.g., "USD")
+     * @param data.date Query date (defaults to today)
+     * @returns BalanceResponse Balance result
+     * @throws ApiError
+     */
+    static getBalance(data: GetBalanceData): CancelablePromise<GetBalanceResponse>;
+    /**
+     * Query multi-currency balance
+     * Get the balance of an account across all currencies
+     * @param data The data for the request.
+     * @param data.region Region code for tenant context
+     * @param data.account Account path (e.g., "Assets:Bank:Checking")
+     * @param data.date Query date (defaults to today)
+     * @returns MultiCurrencyBalanceResponse Multi-currency balance result
+     * @throws ApiError
+     */
+    static getMultiCurrencyBalance(data: GetMultiCurrencyBalanceData): CancelablePromise<GetMultiCurrencyBalanceResponse>;
+}
+//# sourceMappingURL=services.gen.d.ts.map

package/dist/generated/services.gen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.gen.d.ts","sourceRoot":"","sources":["../../src/generated/services.gen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,6BAA6B,EAAE,cAAc,EAAE,kBAAkB,EAAE,eAAe,EAAE,mBAAmB,EAAE,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,mBAAmB,EAAE,eAAe,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,cAAc,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,+BAA+B,EAAE,MAAM,aAAa,CAAC;AAE/sC,qBAAa,aAAa;IACtB;;;;;OAKG;WACW,SAAS,IAAI,iBAAiB,CAAC,iBAAiB,CAAC;CAOlE;AAED,qBAAa,kBAAkB;IAC3B;;;;;;;;;;;;;;OAcG;WACW,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,iBAAiB,CAAC,wBAAwB,CAAC;IAsBvG;;;;;;;;;;;;OAYG;WACW,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,iBAAiB,CAAC,yBAAyB,CAAC;IAgB1G;;;;;;;;OAQG;WACW,cAAc,CAAC,IAAI,EAAE,kBAAkB,GAAG,iBAAiB,CAAC,sBAAsB,CAAC;IAejG;;;;;;;;;OASG;WACW,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,iBAAiB,CAAC,yBAAyB,CAAC;IAkB1G;;;;;;;;OAQG;WACW,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;CAevG;AAED,qBAAa,cAAc;IACvB;;;;;;;;;;;;;OAaG;WACW,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;IAqB3F;;;;;;;;OAQG;WACW,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAgB9F;;;;;;;;OAQG;WACW,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;IAerF;;;;;;;;;OASG;WACW,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAkB9F;;;;;;;;OAQG;WACW,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAgB9F;;;;;;;;OAQG;WACW,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;IAe3F;;;;;;;;OAQG;WACW,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;CAejG;AAED,qBAAa,gBAAgB;IACzB;;;;;;;OAOG;WACW,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAapG;;;;;;;;OAQG;WACW,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAgBpG;;;;;;;;OAQG;WACW,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;IAe3F;;;;;;;;;OASG;WACW,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAkBpG;;;;;;;;OAQG;WACW,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAepG;;;;;;;;;OASG;WACW,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAgBpG;;;;;;;;OAQG;WACW,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,GAAG,iBAAiB,CAAC,6BAA6B,CAAC;CAgBzH;AAED,qBAAa,YAAY;IACrB;;;;;;;OAOG;WACW,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;IAarF;;;;;;;;OAQG;WACW,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;IAgBxF;;;;;;;;OAQG;WACW,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;IAe/E;;;;;;;;;OASG;WACW,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;IAkBxF;;;;;;;;OAQG;WACW,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;IAexF;;;;;;;;OAQG;WACW,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,iBAAiB,CAAC,wBAAwB,CAAC;CAgB1G;AAED,qBAAa,cAAc;IACvB;;;;;;;;;;OAUG;WACW,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;IAmBrF;;;;;;;;;OASG;WACW,uBAAuB,CAAC,IAAI,EAAE,2BAA2B,GAAG,iBAAiB,CAAC,+BAA+B,CAAC;CAkB/H"}