@stable_sea/sdk 0.2.9 → 0.2.11

package/dist/gen/schema.d.ts

@@ -73,7 +73,9 @@ export interface paths {
         };
         /**
          * Read balance history
-         * @description Returns daily settled and pending balances for the authenticated business, grouped by asset, for the last 30 days, 90 days, or the current UTC year. Each series contains at most 367 samples.
+         * @description Returns settled balance history for your business, grouped by asset. Choose a trailing window of 24h, 7d, 30d, 90d or 1y, or ytd for the current UTC year. Each series contains at most 367 samples.
+         *
+         *     The default daily sampling includes pending amounts. Use sampling=chart for the same intervals and aggregate labels as Terminal’s balance chart; chart sampling excludes pending amounts and does not support ytd. The timezone parameter accepts an IANA timezone and defaults to UTC. It controls chart labels; daily and ytd boundaries remain UTC. Inspect start_ts, end_ts and interval_seconds for the exact sample range.
          *
          *     Pending amounts include unfinished internal movements only. ACH, wire and on-chain deposits and withdrawals appear after settlement. Completed legs enter settled history even while other legs remain pending, so these amounts can differ from `/v1/balances`.
          *
@@ -534,10 +536,10 @@ export interface paths {
         get: operations["orders.list"];
         put?: never;
         /**
-         * Place a fund order
-         * @description Creates a fund order for the authenticated business and returns it as `pending`. Execution is asynchronous and uses the same authorization checks and trading engine as Terminal. Retrieve the order to follow it through `executing` to `filled` or `failed`.
+         * Place an order
+         * @description Creates an order for the authenticated business and returns it as `pending`. BTC orders require both `investments:write` and `investments:btc_write` and use standard settlement. The BTC quote is indicative; execution uses the current native price and fees. Execution is asynchronous and uses the same authorization checks and trading engine as Terminal. Retrieve the order to follow it through `executing` to `filled` or `failed`.
          *
-         *     The quoted price is checked against the NAV at execution. Price changes and insufficient express liquidity can cause execution to fail. The failed order includes a reason. While the quote remains valid, an express refusal can be submitted as a new standard order.
+         *     Fund orders check the quoted NAV at execution. Price changes and insufficient express liquidity can cause execution to fail. The failed order includes a reason. While the quote remains valid, an express refusal can be submitted as a new standard order.
          *
          *     Use a Live key with the production URL or a Test key with the sandbox URL. A credential environment this host does not serve returns `environment_not_served` before an order or idempotency record is created.
          */
@@ -596,6 +598,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/portfolio": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read the portfolio
+         * @description Returns Terminal’s portfolio figures for the authenticated business. Requires `money:read`. Balances retain each asset’s rail partition; `asset_summary` includes every partition and is not a per-destination spending limit. Null USD amounts mean unavailable valuations. Totals include only priced holdings, so inspect `unpriced_assets` before treating them as complete.
+         *
+         *     Balance changes include transfers. `daily_return` reports the price return on crypto holdings (currently BTC), adjusted for intraday investment flows. It excludes cash, fund NAV changes and fund income. It has its own observation timestamp. The calendar day uses the requested IANA timezone, defaulting to UTC. The reads are not one atomic ledger snapshot. `details` adds native BTC cost basis and performance, fund income and yield summaries, and the thirty-day WTGXX principal/dividend chart. The worker refreshes these components about once a minute; missing or older-than-two-minutes details are null while base holdings remain available. Individual unavailable components are also null. Yield dates are the issuer’s own as-of dates. Distribution dates use the requested calendar day; pending income is not a promise of payment on that date. The WTGXX chart is measured in fund shares. BTC performance uses UTC day boundaries and Terminal’s existing cost-basis valuation. Computed observations are reported to at most eighteen decimal places; recorded balances retain native precision.
+         */
+        get: operations["portfolio.snapshot"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/price_history": {
         parameters: {
             query?: never;
@@ -628,8 +652,8 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Price a fund trade
-         * @description Returns a price to include when placing a fund order. Quotes are calculated on request, have no ID and cannot be retrieved later.
+         * Price a trade
+         * @description Returns an indicative price for BTC or a fund. Quotes have no ID and cannot be retrieved later. BTC prices use the latest unexpired native quote; reading one does not extend its expiry. Calculated BTC quote amounts are rounded to at most 18 decimal places. Actual trade amounts are determined at execution. BTC quotes include `platform_fee_usdc`, `fee_bps`, `net_usdc` and the `net_estimated_quantity` after the buy fee. `minimum_amount_usd` states the BTC order minimum. A BTC quote does not guarantee the execution price. Fund orders include the quoted NAV.
          *
          *     `express` describes the commission, order limit, estimated quantity and settlement estimate for express settlement. These terms do not guarantee available liquidity. An express order may fail at execution; while the quote remains valid, you can submit a new standard order using the same quoted price. Standard settlement changes the commission and delivered quantity, not the quoted price.
          */
@@ -1154,24 +1178,30 @@ export interface components {
             data: components["schemas"]["BalanceHistorySeries"][];
             /** Format: date-time */
             end_ts: string;
+            interval_seconds: number;
             livemode: boolean;
             /** @enum {string} */
             object: "balance_history";
             /** Format: date-time */
             observed_ts: string;
+            /** @enum {string} */
+            sampling: "daily" | "chart";
             /** Format: date-time */
             start_ts: string;
+            timezone: string;
             /** @description Assets with a nonzero native balance and no USD valuation in at least one sample. Their native balances remain available. */
             unpriced_assets: string[];
         };
         BalanceHistoryTotal: {
             /** @description Sum of the priced settled balances at this timestamp. Inspect unpriced_assets before treating it as a complete valuation. */
             balance_usd: string;
+            /** @description The native chart label in the requested timezone; present with chart sampling. */
+            label?: string;
             /** Format: date-time */
             sampled_ts: string;
         };
         /** @enum {string} */
-        BalanceHistoryWindow: "30d" | "90d" | "ytd";
+        BalanceHistoryWindow: "24h" | "7d" | "30d" | "90d" | "1y" | "ytd";
         BalanceList: {
             data: components["schemas"]["Balance"][];
             has_more: boolean;
@@ -1361,7 +1391,7 @@ export interface components {
                 }[];
                 /** @description Human-readable explanation. Use code or type for programmatic handling. */
                 message?: string;
-                /** @description RFC 6901 JSON Pointer to the first offending field (validation errors). */
+                /** @description RFC 6901 JSON Pointer to the first offending field, on a validation error or a coded error about one field. */
                 param?: string;
                 /** @description Correlates with the Request-Id response header. */
                 request_id?: string;
@@ -1668,23 +1698,25 @@ export interface components {
             /** @enum {string} */
             state: "pending" | "executing" | "filled" | "failed";
             symbol: string;
+            /** @description The booked transaction, or null before a movement is committed. Retrieve it with money:read to follow settlement. A filled order means booked, not settled. */
+            transaction_id: string | null;
         };
         OrderCreateInput: {
-            /** @description The trade size as a decimal string: USD on a buy, shares on a sell. Must be positive. */
+            /** @description The trade size as a decimal string: USD on a buy, asset units on a sell. Must be positive. */
             amount: string;
             /**
              * @description Which side to trade.
              * @enum {string}
              */
             direction: "buy" | "sell";
-            /** @description The price_per_unit from GET /v1/quotes. Execution verifies it against the NAV the trade runs at, so a stale echo is refused rather than filled. */
+            /** @description The price_per_unit from GET /v1/quotes. Fund execution checks the NAV; BTC uses an indicative price and executes at the current native price. */
             quoted_price: string;
             /**
              * @description Settlement mode. Express (instant) carries a commission the standard path does not; see the express terms on GET /v1/quotes. Express draws on a shared reserve, so an express order can be refused at execution and the order reaches a failed state naming why — re-place it as standard against the same unexpired quote.
              * @enum {string}
              */
             settlement: "standard" | "instant";
-            /** @description The fund ticker to trade, e.g. WTGXX. */
+            /** @description The asset ticker, such as BTC or WTGXX. BTC also requires investments:btc_write. */
             symbol: string;
         };
         OrderList: {
@@ -1799,6 +1831,152 @@ export interface components {
         };
         /** @enum {string} */
         PolicyWindowKind: "calendar_day" | "calendar_week" | "rolling_24h" | "rolling_72h";
+        PortfolioAmounts: {
+            available_native: string;
+            available_usd: string | null;
+            balance_native: string;
+            balance_usd: string | null;
+            pending_incoming_native: string;
+            pending_incoming_usd: string | null;
+            pending_outgoing_native: string;
+            pending_outgoing_usd: string | null;
+        };
+        PortfolioAssetReturn: {
+            asset: string;
+            balance_native: string;
+            balance_usd: string;
+            return_percent: string;
+            return_usd: string;
+        };
+        PortfolioBTCPerformance: {
+            average_cost_basis_usd: string | null;
+            gain_loss_percent: string | null;
+            gain_loss_usd: string | null;
+            invested_usd: string | null;
+            last_price_usd: string | null;
+            /** @description Native daily balance samples over thirty days. BTC daily changes use UTC, independently of the portfolio timezone. */
+            series: components["schemas"]["PortfolioBTCPoint"][];
+            thirty_day_change_percent: string | null;
+            thirty_day_change_usd: string | null;
+            today_change_percent: string | null;
+            today_change_usd: string | null;
+        } | null;
+        PortfolioBTCPoint: {
+            balance_native: string;
+            balance_usd: string;
+            /** Format: date-time */
+            sampled_ts: string;
+        };
+        PortfolioDailyReturn: {
+            data: components["schemas"]["PortfolioAssetReturn"][];
+            /** Format: date-time */
+            observed_ts: string;
+            return_percent: string | null;
+            return_usd: string | null;
+            /** Format: date-time */
+            start_ts: string;
+            /** @description Held assets missing a current or opening valuation. Headline return values are null while this list is nonempty; priced per-asset rows remain available. */
+            unpriced_assets: string[];
+        };
+        PortfolioDetails: {
+            btc: components["schemas"]["PortfolioBTCPerformance"];
+            fund_income: components["schemas"]["PortfolioFundIncome"][];
+            funds: components["schemas"]["PortfolioFundSummary"];
+            /** Format: date-time */
+            observed_ts: string;
+            wtgxx_chart: components["schemas"]["PortfolioPrincipalChart"];
+        } | null;
+        PortfolioFundIncome: {
+            asset: string;
+            available: boolean;
+            daily_yield: components["schemas"]["PortfolioYield"];
+            dividends_paid_usd: string | null;
+            /** @description Only WTGXX declares daily accrued income. Variable-NAV funds have no open daily accrual. */
+            pending_dividend_usd: string | null;
+            seven_day_yield: components["schemas"]["PortfolioYield"];
+            /** Format: int64 */
+            unpriced_dividend_count: number;
+        };
+        PortfolioFundPosition: {
+            asset: string;
+            asset_class: string;
+            balance_native: string;
+            balance_usd: string | null;
+            money_market: boolean;
+            /** Format: date */
+            next_distribution_date: string | null;
+            yield: components["schemas"]["PortfolioYield"];
+        };
+        PortfolioFundSummary: {
+            daily_yield: components["schemas"]["PortfolioYield"];
+            /** @description Whether WTGXX's New York calendar is currently on a published payable date. */
+            distribution_day: boolean;
+            /** @description Lifetime dividends across registered funds, including redeemed positions. Null when a payout could not be valued. */
+            dividends_paid_usd: string | null;
+            /** Format: date */
+            next_distribution_date: string | null;
+            /** @description Authoritative open WTGXX accrual; null when unavailable. This is not a promise that the amount will be paid on the next scheduled date. */
+            pending_dividend_usd: string | null;
+            positions: components["schemas"]["PortfolioFundPosition"][];
+            unpriced_dividend_count: number;
+        } | null;
+        PortfolioHolding: {
+            asset: string;
+            asset_summary: components["schemas"]["PortfolioAmounts"];
+            available_native: string;
+            available_usd: string | null;
+            /** @description Balance change since the requested local day began, including transfers. Null when the comparison cannot be valued. */
+            balance_change_usd: string | null;
+            balance_native: string;
+            balance_usd: string | null;
+            /** @description Completed dividends during the requested local day, valued in USD. Null for unsupported assets or unavailable valuations. */
+            dividends_paid_usd: string | null;
+            /** @enum {string} */
+            object: "portfolio_holding";
+            pending_incoming_native: string;
+            pending_incoming_usd: string | null;
+            pending_outgoing_native: string;
+            pending_outgoing_usd: string | null;
+            /** @description Price change since the requested local day began, excluding transfers. Null when a required price is unavailable. */
+            price_change_percent: string | null;
+            segregated_rail: string;
+        };
+        PortfolioPrincipalChart: {
+            /** @enum {string} */
+            asset: "WTGXX";
+            points: components["schemas"]["PortfolioPrincipalPoint"][];
+            /** @enum {string} */
+            window: "30d";
+        } | null;
+        PortfolioPrincipalPoint: {
+            dividends_native: string;
+            principal_native: string;
+            /** Format: date-time */
+            sampled_ts: string;
+        };
+        PortfolioSnapshot: {
+            /** @description Balance change since the local day began, including transfers. Null when a held position lacks a current or opening valuation. */
+            balance_change_usd: string | null;
+            balance_usd: string;
+            daily_return: components["schemas"]["PortfolioDailyReturn"];
+            data: components["schemas"]["PortfolioHolding"][];
+            /** Format: date-time */
+            day_start_ts: string;
+            details: components["schemas"]["PortfolioDetails"];
+            livemode: boolean;
+            /** @enum {string} */
+            object: "portfolio";
+            /** Format: date-time */
+            observed_ts: string;
+            timezone: string;
+            unpriced_assets: string[];
+        };
+        PortfolioYield: {
+            /** Format: date */
+            as_of: string;
+            label: string;
+            percent: string;
+        } | null;
         PriceHistorySnapshot: {
             data: components["schemas"]["MarketPriceSeries"][];
             /** Format: date-time */
@@ -1810,8 +1988,10 @@ export interface components {
             observed_ts: string;
             /** Format: date-time */
             start_ts: string;
-            window: components["schemas"]["BalanceHistoryWindow"];
+            window: components["schemas"]["PriceHistoryWindow"];
         };
+        /** @enum {string} */
+        PriceHistoryWindow: "30d" | "90d" | "ytd";
         Quote: {
             amount_usd: string;
             /** @enum {string} */
@@ -1820,9 +2000,19 @@ export interface components {
             /** Format: date-time */
             expires_ts: string;
             express?: components["schemas"]["QuoteExpress"];
+            /** @description Native BTC platform fee rate, in basis points. */
+            fee_bps?: number | null;
             livemode: boolean;
+            /** @description Minimum BTC order notional in USD, before the platform fee. */
+            minimum_amount_usd?: string;
+            /** @description Estimated BTC received after the buy fee. Omitted on sells. */
+            net_estimated_quantity?: string | null;
+            /** @description USDC allocated to a BTC buy, or estimated sell proceeds, after the fee. */
+            net_usdc?: string;
             /** @enum {string} */
             object: "quote";
+            /** @description Estimated native BTC platform fee in USDC. */
+            platform_fee_usdc?: string;
             price_per_unit: string;
             symbol: string;
         };
@@ -2362,13 +2552,13 @@ export interface components {
         TransactionSide: {
             amount: string;
             asset: string;
-            /** @description Your bank-account resource, omitted after removal. Retrieve it with accounts:read for account details. */
+            /** @description Your bank-account resource, omitted after removal. Retrieve it with money:read for account details. */
             bank_account_id?: string;
             /** @description Blockchain used by this ledger leg, when it names one. Internal conversions and bank legs have no chain. */
             chain?: string;
             /** @description Whether this figure can still change. False also covers terminal failure and a fund-trade amount fixed at placement; it does not prove settlement. */
             estimated: boolean;
-            /** @description Your external-wallet resource, omitted after removal. Retrieve it with accounts:read for wallet details. */
+            /** @description Your external-wallet resource, omitted after removal. Retrieve it with money:read for wallet details. */
             external_wallet_id?: string;
             quoted?: components["schemas"]["TransactionValue"];
         };
@@ -2701,8 +2891,12 @@ export interface operations {
     "balance_history.snapshot": {
         parameters: {
             query?: {
-                /** @description Thirty days, ninety days, or the current UTC year to date. */
+                /** @description IANA timezone for the calendar day and chart labels, such as America/Los_Angeles. Defaults to UTC. */
+                timezone?: string;
+                /** @description A trailing window, or the current UTC year to date. */
                 window?: components["schemas"]["BalanceHistoryWindow"];
+                /** @description Daily account history or Terminal chart intervals. Chart sampling excludes pending amounts and does not support ytd. */
+                sampling?: "daily" | "chart";
             };
             header?: never;
             path?: never;
@@ -3792,11 +3986,50 @@ export interface operations {
             };
         };
     };
+    "portfolio.snapshot": {
+        parameters: {
+            query?: {
+                /** @description IANA timezone for the calendar day and chart labels, such as America/Los_Angeles. Defaults to UTC. */
+                timezone?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    "X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
+                    "X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
+                    "X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PortfolioSnapshot"];
+                };
+            };
+            400: components["responses"]["Error400"];
+            401: components["responses"]["Error401"];
+            403: components["responses"]["Error403"];
+            429: components["responses"]["Error429"];
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "price_history.snapshot": {
         parameters: {
             query?: {
                 /** @description Thirty days, ninety days, or the current UTC year to date. */
-                window?: components["schemas"]["BalanceHistoryWindow"];
+                window?: components["schemas"]["PriceHistoryWindow"];
             };
             header?: never;
             path?: never;
@@ -3834,11 +4067,11 @@ export interface operations {
     "quotes.quote": {
         parameters: {
             query: {
-                /** @description The fund ticker to price, e.g. WTGXX. */
+                /** @description The asset ticker to price, such as BTC or WTGXX. */
                 symbol: string;
                 /** @description Which side to price. */
                 direction: "buy" | "sell";
-                /** @description The trade size as a decimal string: USD on a buy, shares on a sell. Must be positive. */
+                /** @description The trade size as a decimal string: USD on a buy, asset units on a sell. Must be positive. */
                 amount: string;
             };
             header?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stable_sea/sdk",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "type": "module",
   "sideEffects": false,
   "files": [