@firela/api-types 0.0.0-canary.a7bda42

package/dist/generated/services.gen.js

@@ -0,0 +1,705 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { OpenAPI } from './core/OpenAPI';
+import { request as __request } from './core/request';
+export class HealthService {
+    /**
+     * Health check
+     * Returns the health status of the API service
+     * @returns HealthResponse Service is healthy
+     * @throws ApiError
+     */
+    static getHealth() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/health'
+        });
+    }
+}
+export 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/transactions',
+            path: {
+                region: data.region
+            },
+            query: {
+                limit: data.limit,
+                offset: data.offset,
+                dateFrom: data.dateFrom,
+                dateTo: data.dateTo,
+                status: data.status,
+                search: data.search,
+                accountId: data.accountId
+            },
+            errors: {
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/transactions',
+            path: {
+                region: data.region
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/transactions/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/{region}/bean/transactions/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/{region}/bean/transactions/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+}
+export 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/accounts',
+            path: {
+                region: data.region
+            },
+            query: {
+                type: data.type,
+                status: data.status,
+                isCustom: data.isCustom,
+                search: data.search,
+                limit: data.limit,
+                offset: data.offset
+            },
+            errors: {
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/accounts',
+            path: {
+                region: data.region
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/accounts/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/{region}/bean/accounts/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/{region}/bean/accounts/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found',
+                409: 'Resource conflict (e.g., account has postings)'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/accounts/{id}/close',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/accounts/{id}/reopen',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+}
+export 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/commodities',
+            path: {
+                region: data.region
+            },
+            errors: {
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/commodities',
+            path: {
+                region: data.region
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/commodities/{symbol}',
+            path: {
+                region: data.region,
+                symbol: data.symbol
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/{region}/bean/commodities/{symbol}',
+            path: {
+                region: data.region,
+                symbol: data.symbol
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/{region}/bean/commodities/{symbol}',
+            path: {
+                region: data.region,
+                symbol: data.symbol
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/commodities/{symbol}/ensure',
+            path: {
+                region: data.region,
+                symbol: data.symbol
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/commodities/bulk',
+            path: {
+                region: data.region
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required'
+            }
+        });
+    }
+}
+export 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/prices',
+            path: {
+                region: data.region
+            },
+            errors: {
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/prices',
+            path: {
+                region: data.region
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/prices/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/{region}/bean/prices/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/{region}/bean/prices/{id}',
+            path: {
+                region: data.region,
+                id: data.id
+            },
+            errors: {
+                401: 'Authentication required',
+                404: 'Resource not found'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/{region}/bean/prices/bulk',
+            path: {
+                region: data.region
+            },
+            body: data.requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required'
+            }
+        });
+    }
+}
+export 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/balances',
+            path: {
+                region: data.region
+            },
+            query: {
+                account: data.account,
+                date: data.date,
+                currency: data.currency
+            },
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required'
+            }
+        });
+    }
+    /**
+     * 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) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/{region}/bean/balances/multi-currency',
+            path: {
+                region: data.region
+            },
+            query: {
+                account: data.account,
+                date: data.date
+            },
+            errors: {
+                400: 'Invalid request parameters',
+                401: 'Authentication required'
+            }
+        });
+    }
+}