@onesi/genesis 0.1.13 → 0.2.1

package/dist/garden.d.ts

@@ -0,0 +1,754 @@
+import type { GenesisClient } from './client.js';
+import type { OperationInput as In } from './types.js';
+type Page = {
+    limit?: number;
+    offset?: number;
+};
+type SpendStatus = 'requires_authority' | 'succeeded' | 'failed' | 'cancelled';
+/** Garden (finance): books, chart of accounts, journal, customers and vendors, invoices, payments, payouts,
+ * reports and the audit trail. Changes to an existing record take the `version` you read (sent as If-Match);
+ * payments, payouts and invoice receipts take an optional idempotency key (a retry returns the first result). */
+export declare function gardenModule(client: GenesisClient): {
+    whoami: () => Promise<{
+        org: string;
+        principal: string;
+        kind: "api_key" | "m2m_token" | "bridge_session";
+        scopes: string[];
+    }>;
+    books: {
+        list: (includeArchived?: boolean) => Promise<{
+            data: import("./index.js").components["schemas"]["Garden.Books"][];
+        }>;
+        get: (books: string) => Promise<{
+            id: string;
+            name: string;
+            currency: string;
+            auto_org_id: string | null;
+            status: "active" | "archived";
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        create: (body: In<"garden_createBooks">["body"]) => Promise<{
+            id: string;
+            name: string;
+            currency: string;
+            auto_org_id: string | null;
+            status: "active" | "archived";
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        update: (books: string, version: number | string, body: In<"garden_updateBooks">["body"]) => Promise<{
+            id: string;
+            name: string;
+            currency: string;
+            auto_org_id: string | null;
+            status: "active" | "archived";
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        archive: (books: string, version: number | string) => Promise<{
+            id: string;
+            name: string;
+            currency: string;
+            auto_org_id: string | null;
+            status: "active" | "archived";
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        accounts: (books: string, includeArchived?: boolean) => Promise<{
+            data: import("./index.js").components["schemas"]["Garden.Account"][];
+        }>;
+        createAccount: (books: string, body: In<"garden_createAccount">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            code: string;
+            name: string;
+            type: import("./index.js").components["schemas"]["Garden.AccountType"];
+            subtype: string;
+            normal_balance: "debit" | "credit";
+            status: "active" | "archived";
+            balance?: number;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        journalEntries: (books: string, filter?: {
+            status?: "draft" | "posted" | "reversed" | "discarded";
+            from?: string;
+            to?: string;
+        } & Page) => Promise<{
+            data: import("./index.js").components["schemas"]["Garden.JournalEntry"][];
+        }>;
+        createJournalEntry: (books: string, body: In<"garden_createJournalEntry">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            entry_date: string;
+            description: string;
+            memo: string | null;
+            status: "draft" | "posted" | "reversed" | "discarded";
+            source: {
+                type: string;
+                id: string;
+            } | null;
+            reverses_id: string | null;
+            reversed_by_id: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.JournalLine"][];
+            total: number;
+            created_by: string;
+            posted_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        counterparties: (books: string, filter?: {
+            kind?: "customer" | "vendor";
+            include_archived?: boolean;
+        }) => Promise<{
+            data: import("./index.js").components["schemas"]["Garden.Counterparty"][];
+        }>;
+        createCounterparty: (books: string, body: In<"garden_createCounterparty">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            name: string;
+            email: string | null;
+            kind: "customer" | "vendor" | "both";
+            principal: string | null;
+            status: "active" | "archived";
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        invoices: (books: string, filter?: {
+            status?: In<"garden_listInvoices">["status"];
+            customer_id?: string;
+        } & Page) => Promise<{
+            data: import("./index.js").components["schemas"]["Garden.Invoice"][];
+        }>;
+        createInvoice: (books: string, body: In<"garden_createInvoice">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            customer_id: string;
+            currency: string;
+            issue_date: string;
+            due_date: string;
+            memo: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.InvoiceLine"][];
+            subtotal: number;
+            tax: number;
+            total: number;
+            amount_paid: number;
+            amount_written_off: number;
+            amount_due: number;
+            status: import("./index.js").components["schemas"]["Garden.InvoiceStatus"];
+            journal_entry_id: string | null;
+            created_by: string;
+            finalized_at: string | null;
+            paid_at: string | null;
+            voided_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        payments: (books: string, filter?: {
+            status?: SpendStatus;
+        } & Page) => Promise<{
+            data: import("./index.js").components["schemas"]["Garden.Disbursement"][];
+        }>;
+        /** 201 when it settled, 202 while it waits for authority, 200 when replayed with the same key. */
+        createPayment: (books: string, body: In<"garden_createPayment">["body"], idempotencyKey?: string) => Promise<{
+            id: string;
+            object: "payment" | "payout";
+            books_id: string;
+            type: string;
+            counterparty_id: string | null;
+            amount: number;
+            currency: string;
+            from_account_id: string;
+            to_account_id: string;
+            memo: string;
+            rail: import("./index.js").components["schemas"]["Garden.Rail"];
+            livemode: false;
+            status: import("./index.js").components["schemas"]["Garden.DisbursementStatus"];
+            authority: unknown;
+            failure: unknown;
+            requested_by: string;
+            authorized_by: string | null;
+            journal_entry_id: string | null;
+            settled_at: string | null;
+            cancelled_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        payouts: (books: string, filter?: {
+            status?: SpendStatus;
+        } & Page) => Promise<{
+            data: import("./index.js").components["schemas"]["Garden.Disbursement"][];
+        }>;
+        /** Needs garden:manage. 201 when it settled, 202 while it waits for authority, 200 when replayed with the same key. */
+        createPayout: (books: string, body: In<"garden_createPayout">["body"], idempotencyKey?: string) => Promise<{
+            id: string;
+            object: "payment" | "payout";
+            books_id: string;
+            type: string;
+            counterparty_id: string | null;
+            amount: number;
+            currency: string;
+            from_account_id: string;
+            to_account_id: string;
+            memo: string;
+            rail: import("./index.js").components["schemas"]["Garden.Rail"];
+            livemode: false;
+            status: import("./index.js").components["schemas"]["Garden.DisbursementStatus"];
+            authority: unknown;
+            failure: unknown;
+            requested_by: string;
+            authorized_by: string | null;
+            journal_entry_id: string | null;
+            settled_at: string | null;
+            cancelled_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        /** Oldest first from `after` (response `next_after`), or newest first with `order: 'desc'` from `before` (response `next_before`). */
+        events: (books: string, page?: {
+            order?: "asc" | "desc";
+            after?: number;
+            before?: number;
+            limit?: number;
+        }) => Promise<{
+            data: import("./index.js").components["schemas"]["Garden.Event"][];
+            next_after?: number | null;
+            next_before?: number | null;
+        }>;
+        verifyEvents: (books: string) => Promise<{
+            ok: boolean;
+            events: number;
+            head?: string;
+            broken_at?: number;
+        }>;
+    };
+    reports: {
+        trialBalance: (books: string, asOf?: string) => Promise<{
+            books_id: string;
+            currency: string;
+            as_of: string;
+            accounts: {
+                account_id: string;
+                code: string;
+                name: string;
+                type: import("./index.js").components["schemas"]["Garden.AccountType"];
+                subtype: string;
+                debits: number;
+                credits: number;
+                balance: number;
+                debit_balance: number;
+                credit_balance: number;
+            }[];
+            total_debits: number;
+            total_credits: number;
+            balanced: boolean;
+        }>;
+        balanceSheet: (books: string, asOf?: string) => Promise<{
+            books_id: string;
+            currency: string;
+            as_of: string;
+            assets: import("./index.js").components["schemas"]["Garden.ReportLine"][];
+            liabilities: import("./index.js").components["schemas"]["Garden.ReportLine"][];
+            equity: import("./index.js").components["schemas"]["Garden.ReportLine"][];
+            current_earnings: number;
+            total_assets: number;
+            total_liabilities: number;
+            total_equity: number;
+            balanced: boolean;
+        }>;
+        incomeStatement: (books: string, from: string, to: string) => Promise<{
+            books_id: string;
+            currency: string;
+            from: string;
+            to: string;
+            revenue: import("./index.js").components["schemas"]["Garden.ReportLine"][];
+            expenses: import("./index.js").components["schemas"]["Garden.ReportLine"][];
+            total_revenue: number;
+            total_expenses: number;
+            net_income: number;
+            margin_bps: number | null;
+        }>;
+        arAging: (books: string, asOf?: string) => Promise<{
+            books_id: string;
+            currency: string;
+            as_of: string;
+            invoices: {
+                invoice_id: string;
+                number: string | null;
+                customer_id: string;
+                customer_name: string;
+                due_date: string;
+                days_past_due: number;
+                amount_due: number;
+                bucket: "current" | "1_30" | "31_60" | "61_90" | "over_90";
+            }[];
+            buckets: {
+                current: number;
+                "1_30": number;
+                "31_60": number;
+                "61_90": number;
+                over_90: number;
+            };
+            total_due: number;
+        }>;
+    };
+    accounts: {
+        get: (account: string) => Promise<{
+            id: string;
+            books_id: string;
+            code: string;
+            name: string;
+            type: import("./index.js").components["schemas"]["Garden.AccountType"];
+            subtype: string;
+            normal_balance: "debit" | "credit";
+            status: "active" | "archived";
+            balance?: number;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        update: (account: string, version: number | string, body: In<"garden_updateAccount">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            code: string;
+            name: string;
+            type: import("./index.js").components["schemas"]["Garden.AccountType"];
+            subtype: string;
+            normal_balance: "debit" | "credit";
+            status: "active" | "archived";
+            balance?: number;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+    };
+    journalEntries: {
+        get: (entry: string) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            entry_date: string;
+            description: string;
+            memo: string | null;
+            status: "draft" | "posted" | "reversed" | "discarded";
+            source: {
+                type: string;
+                id: string;
+            } | null;
+            reverses_id: string | null;
+            reversed_by_id: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.JournalLine"][];
+            total: number;
+            created_by: string;
+            posted_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        update: (entry: string, version: number | string, body: In<"garden_updateJournalEntry">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            entry_date: string;
+            description: string;
+            memo: string | null;
+            status: "draft" | "posted" | "reversed" | "discarded";
+            source: {
+                type: string;
+                id: string;
+            } | null;
+            reverses_id: string | null;
+            reversed_by_id: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.JournalLine"][];
+            total: number;
+            created_by: string;
+            posted_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        discard: (entry: string, version: number | string) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            entry_date: string;
+            description: string;
+            memo: string | null;
+            status: "draft" | "posted" | "reversed" | "discarded";
+            source: {
+                type: string;
+                id: string;
+            } | null;
+            reverses_id: string | null;
+            reversed_by_id: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.JournalLine"][];
+            total: number;
+            created_by: string;
+            posted_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        post: (entry: string, version: number | string) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            entry_date: string;
+            description: string;
+            memo: string | null;
+            status: "draft" | "posted" | "reversed" | "discarded";
+            source: {
+                type: string;
+                id: string;
+            } | null;
+            reverses_id: string | null;
+            reversed_by_id: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.JournalLine"][];
+            total: number;
+            created_by: string;
+            posted_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        reverse: (entry: string, body?: In<"garden_reverseJournalEntry">["body"]) => Promise<{
+            reversed: import("./index.js").components["schemas"]["Garden.JournalEntry"];
+            reversal: import("./index.js").components["schemas"]["Garden.JournalEntry"];
+        }>;
+    };
+    counterparties: {
+        get: (counterparty: string) => Promise<{
+            id: string;
+            books_id: string;
+            name: string;
+            email: string | null;
+            kind: "customer" | "vendor" | "both";
+            principal: string | null;
+            status: "active" | "archived";
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        update: (counterparty: string, version: number | string, body: In<"garden_updateCounterparty">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            name: string;
+            email: string | null;
+            kind: "customer" | "vendor" | "both";
+            principal: string | null;
+            status: "active" | "archived";
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+    };
+    invoices: {
+        get: (invoice: string) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            customer_id: string;
+            currency: string;
+            issue_date: string;
+            due_date: string;
+            memo: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.InvoiceLine"][];
+            subtotal: number;
+            tax: number;
+            total: number;
+            amount_paid: number;
+            amount_written_off: number;
+            amount_due: number;
+            status: import("./index.js").components["schemas"]["Garden.InvoiceStatus"];
+            journal_entry_id: string | null;
+            created_by: string;
+            finalized_at: string | null;
+            paid_at: string | null;
+            voided_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        } & {
+            receipts: import("./index.js").components["schemas"]["Garden.Receipt"][];
+        }>;
+        update: (invoice: string, version: number | string, body: In<"garden_updateInvoice">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            customer_id: string;
+            currency: string;
+            issue_date: string;
+            due_date: string;
+            memo: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.InvoiceLine"][];
+            subtotal: number;
+            tax: number;
+            total: number;
+            amount_paid: number;
+            amount_written_off: number;
+            amount_due: number;
+            status: import("./index.js").components["schemas"]["Garden.InvoiceStatus"];
+            journal_entry_id: string | null;
+            created_by: string;
+            finalized_at: string | null;
+            paid_at: string | null;
+            voided_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        finalize: (invoice: string, version: number | string) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            customer_id: string;
+            currency: string;
+            issue_date: string;
+            due_date: string;
+            memo: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.InvoiceLine"][];
+            subtotal: number;
+            tax: number;
+            total: number;
+            amount_paid: number;
+            amount_written_off: number;
+            amount_due: number;
+            status: import("./index.js").components["schemas"]["Garden.InvoiceStatus"];
+            journal_entry_id: string | null;
+            created_by: string;
+            finalized_at: string | null;
+            paid_at: string | null;
+            voided_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        void: (invoice: string, version: number | string, body?: In<"garden_voidInvoice">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            customer_id: string;
+            currency: string;
+            issue_date: string;
+            due_date: string;
+            memo: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.InvoiceLine"][];
+            subtotal: number;
+            tax: number;
+            total: number;
+            amount_paid: number;
+            amount_written_off: number;
+            amount_due: number;
+            status: import("./index.js").components["schemas"]["Garden.InvoiceStatus"];
+            journal_entry_id: string | null;
+            created_by: string;
+            finalized_at: string | null;
+            paid_at: string | null;
+            voided_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        markUncollectible: (invoice: string, version: number | string, body?: In<"garden_markInvoiceUncollectible">["body"]) => Promise<{
+            id: string;
+            books_id: string;
+            number: string | null;
+            customer_id: string;
+            currency: string;
+            issue_date: string;
+            due_date: string;
+            memo: string | null;
+            lines: import("./index.js").components["schemas"]["Garden.InvoiceLine"][];
+            subtotal: number;
+            tax: number;
+            total: number;
+            amount_paid: number;
+            amount_written_off: number;
+            amount_due: number;
+            status: import("./index.js").components["schemas"]["Garden.InvoiceStatus"];
+            journal_entry_id: string | null;
+            created_by: string;
+            finalized_at: string | null;
+            paid_at: string | null;
+            voided_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        /** 201 when recorded, 200 when replayed with the same key. */
+        recordPayment: (invoice: string, body: In<"garden_recordInvoicePayment">["body"], idempotencyKey?: string) => Promise<{
+            invoice: import("./index.js").components["schemas"]["Garden.Invoice"];
+            receipt: import("./index.js").components["schemas"]["Garden.Receipt"];
+        }>;
+    };
+    payments: {
+        get: (payment: string) => Promise<{
+            id: string;
+            object: "payment" | "payout";
+            books_id: string;
+            type: string;
+            counterparty_id: string | null;
+            amount: number;
+            currency: string;
+            from_account_id: string;
+            to_account_id: string;
+            memo: string;
+            rail: import("./index.js").components["schemas"]["Garden.Rail"];
+            livemode: false;
+            status: import("./index.js").components["schemas"]["Garden.DisbursementStatus"];
+            authority: unknown;
+            failure: unknown;
+            requested_by: string;
+            authorized_by: string | null;
+            journal_entry_id: string | null;
+            settled_at: string | null;
+            cancelled_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        /** As the principal Auto escalated to: 200 when it settled or failed, 202 while it still waits. */
+        authorize: (payment: string) => Promise<{
+            id: string;
+            object: "payment" | "payout";
+            books_id: string;
+            type: string;
+            counterparty_id: string | null;
+            amount: number;
+            currency: string;
+            from_account_id: string;
+            to_account_id: string;
+            memo: string;
+            rail: import("./index.js").components["schemas"]["Garden.Rail"];
+            livemode: false;
+            status: import("./index.js").components["schemas"]["Garden.DisbursementStatus"];
+            authority: unknown;
+            failure: unknown;
+            requested_by: string;
+            authorized_by: string | null;
+            journal_entry_id: string | null;
+            settled_at: string | null;
+            cancelled_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        cancel: (payment: string, body?: In<"garden_cancelPayment">["body"]) => Promise<{
+            id: string;
+            object: "payment" | "payout";
+            books_id: string;
+            type: string;
+            counterparty_id: string | null;
+            amount: number;
+            currency: string;
+            from_account_id: string;
+            to_account_id: string;
+            memo: string;
+            rail: import("./index.js").components["schemas"]["Garden.Rail"];
+            livemode: false;
+            status: import("./index.js").components["schemas"]["Garden.DisbursementStatus"];
+            authority: unknown;
+            failure: unknown;
+            requested_by: string;
+            authorized_by: string | null;
+            journal_entry_id: string | null;
+            settled_at: string | null;
+            cancelled_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+    };
+    /** Payout authorize and cancel need garden:manage. */
+    payouts: {
+        get: (payout: string) => Promise<{
+            id: string;
+            object: "payment" | "payout";
+            books_id: string;
+            type: string;
+            counterparty_id: string | null;
+            amount: number;
+            currency: string;
+            from_account_id: string;
+            to_account_id: string;
+            memo: string;
+            rail: import("./index.js").components["schemas"]["Garden.Rail"];
+            livemode: false;
+            status: import("./index.js").components["schemas"]["Garden.DisbursementStatus"];
+            authority: unknown;
+            failure: unknown;
+            requested_by: string;
+            authorized_by: string | null;
+            journal_entry_id: string | null;
+            settled_at: string | null;
+            cancelled_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        authorize: (payout: string) => Promise<{
+            id: string;
+            object: "payment" | "payout";
+            books_id: string;
+            type: string;
+            counterparty_id: string | null;
+            amount: number;
+            currency: string;
+            from_account_id: string;
+            to_account_id: string;
+            memo: string;
+            rail: import("./index.js").components["schemas"]["Garden.Rail"];
+            livemode: false;
+            status: import("./index.js").components["schemas"]["Garden.DisbursementStatus"];
+            authority: unknown;
+            failure: unknown;
+            requested_by: string;
+            authorized_by: string | null;
+            journal_entry_id: string | null;
+            settled_at: string | null;
+            cancelled_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+        cancel: (payout: string, body?: In<"garden_cancelPayout">["body"]) => Promise<{
+            id: string;
+            object: "payment" | "payout";
+            books_id: string;
+            type: string;
+            counterparty_id: string | null;
+            amount: number;
+            currency: string;
+            from_account_id: string;
+            to_account_id: string;
+            memo: string;
+            rail: import("./index.js").components["schemas"]["Garden.Rail"];
+            livemode: false;
+            status: import("./index.js").components["schemas"]["Garden.DisbursementStatus"];
+            authority: unknown;
+            failure: unknown;
+            requested_by: string;
+            authorized_by: string | null;
+            journal_entry_id: string | null;
+            settled_at: string | null;
+            cancelled_at: string | null;
+            version: number;
+            created_at: string;
+            updated_at: string;
+        }>;
+    };
+};
+export {};