@stable_sea/sdk 0.2.41 → 0.2.42

package/dist/gen/session-schema.d.ts

@@ -1784,6 +1784,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/money/maintenance": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Handler Get Maintenance */
+        get: operations["money.maintenance.get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/money/onchain/withdrawals": {
         parameters: {
             query?: never;
@@ -1806,6 +1823,118 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/money/swap_estimate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Estimate a swap
+         * @description Prices one stablecoin swap in the business's Go Account without committing anything, for a client to call as the amount is typed. The rate is indicative; POST /money/swap_quotes fixes a firm one. The estimate runs the quote's checks and reports the first that fails as refusal_reason, except the provider's own balance, which only the quote checks.
+         *
+         *     Requires kyb_locked, and assets_buy to swap USDC out or assets_sell to swap USDT into USDC. A business whose swap money movement type is off is refused with 403 money_movement_type_disabled.
+         */
+        get: operations["money.swap_estimate.get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/money/swap_quotes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Quote a swap
+         * @description Mints a firm quote for one stablecoin swap in the business's Go Account: the provider's all-in rate, the business's swap fee frozen at its current schedule, and the amounts sent and received, until expires_ts. The swap create consumes the quote by id, once. Nothing moves until then.
+         *
+         *     Every check runs before the quote is stored, and a failed check answers its error code: swap_custody_mode_unsupported, swap_amount_too_small, swap_amount_too_large, movement_limit_exceeded (the swap daily limit), insufficient_balance, swap_provider_balance_unsettled, swap_rate_out_of_bounds, then swap_route_unavailable (503) when the provider cannot quote. Requires kyb_locked, and assets_buy to swap USDC out or assets_sell to swap USDT into USDC. A business whose swap money movement type is off is refused with 403 money_movement_type_disabled.
+         *
+         *     Requires an Idempotency-Key. A key already used with the same body is refused with 409 duplicate_idempotency_key, and with a different body with 400 idempotency_key_body_mismatch; neither returns the original quote, so keep the quote_id from the first answer. A refused request claims no key and can be sent again.
+         */
+        post: operations["money.swap_quotes.create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/money/swap_routes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List swap routes
+         * @description Reports whether the business can swap stablecoins in its Go Account and, when it can, the swap routes: each route's assets, the least and most a swap sends, the business's swap fee rate, and the available balance of each asset. A business whose swap money movement type is off reads enabled=false and no routes. Any member of the business can read it.
+         */
+        get: operations["money.swap_routes.list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/money/swap_submissions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve a swap submission
+         * @description Finds the signed-in member's swap by the Idempotency-Key of its POST /money/swaps, after a timeout or a lost response, and answers its transaction. It never executes or retries anything. Requires permission to view transactions.
+         *
+         *     Request keys are kept for at least 24 hours. A 404 can mean the request is still in flight or its key is no longer kept; it does not prove that no swap was created. Keep the original key and check the transaction history before executing a new quote.
+         */
+        get: operations["money.swap_submissions.get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/money/swaps": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Execute a swap
+         * @description Executes a firm swap quote (POST /money/swap_quotes) in the business's Go Account and answers the swap's transaction with outcome=created. The swap is final once transaction.status is completed; it reads failed, with no money moved, when the provider refuses or kills the order. A quote executes once, before its expires_ts.
+         *
+         *     Every check the quote ran runs again, then the business must not be archived or locked and must have signed its service agreements. Refusals: quote_not_found (404), quote_expired, swap_quote_used (409, the quote already executed), and the quote's own codes. Requires kyb_locked, and assets_buy to swap USDC out or assets_sell to swap USDT into USDC. A business whose swap money movement type is off is refused with 403 money_movement_type_disabled.
+         *
+         *     Requires an Idempotency-Key. A key already used with the same body is refused with 409 duplicate_idempotency_key, and with a different body with 400 idempotency_key_body_mismatch. After a lost response, GET /money/swap_submissions finds the swap by the key; never execute the quote again under a new key.
+         */
+        post: operations["money.swaps.create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/money/test_approval_rules": {
         parameters: {
             query?: never;
@@ -3723,6 +3852,8 @@ export interface components {
             added_by_stable_sea?: boolean;
             address?: string;
             counterparty?: string;
+            /** @description For a cash-home Ethereum USDC destination, true when no confirmed withdrawal from the current segregated wallet to this address is recorded. False when one is recorded; absent when not applicable or history is unavailable. A first withdrawal may be held for custodian verification. Submission still rechecks all withdrawal controls. */
+            custodial_first_withdrawal?: boolean;
             /** @description Ready-to-open block-explorer URL for the address; absent when the rail has no explorer, in which case render the address as plain text. */
             explorer_url?: string;
             id?: string;
@@ -3826,6 +3957,12 @@ export interface components {
             contents?: string;
             found?: boolean;
         };
+        MoneyMovementsBusinessMaintenanceView: {
+            paused: boolean;
+            revision: string;
+            /** Format: date-time */
+            updated_ts?: string | null;
+        };
         MoneyMovementsCreateOnchainWithdrawalInput: {
             account_id: string;
             amount: string;
@@ -4071,6 +4208,108 @@ export interface components {
         };
         /** @enum {string} */
         MoneyenumTransferApprovalVoteDecision: "approved" | "denied";
+        /** @enum {string} */
+        SwapsRouteID: "ethereum_usdc_usdt";
+        /** @enum {string} */
+        SwapsAsset: "USDC" | "USDT";
+        /** @enum {string} */
+        SwapsAmountSide: "send" | "receive";
+        SwapsEstimateOutput: {
+            /** @description The swap fee, always in USDC: a decimal string at six places. */
+            fee_amount: string;
+            /**
+             * Format: int64
+             * @description The swap fee rate, in basis points of the swap's USDC side.
+             */
+            fee_bps: number;
+            /** @description The all-in exchange rate, to_asset per one from_asset, before the swap fee: a decimal string at eight places. */
+            rate: string;
+            /** @description The amount of to_asset received, after the fee when to_asset is USDC: a decimal string at six places. */
+            receive_amount: string;
+            refusal_reason: components["schemas"]["SwapsRefusal"];
+            /** @description Whether the swap can go on to a firm quote (POST /money/swap_quotes). False exactly when refusal_reason is set. */
+            reviewable: boolean;
+            /** @description The amount of from_asset sent, fee included when from_asset is USDC: a decimal string at six places. */
+            send_amount: string;
+            /** @description How far rate is from 1:1, in basis points, as a decimal string at two places: positive when the business receives less than it sends, before the fee. */
+            spread_bps: string;
+        };
+        /** @enum {string|null} */
+        SwapsRefusal: "swap_custody_mode_unsupported" | "swap_amount_too_small" | "swap_amount_too_large" | "movement_limit_exceeded" | "insufficient_balance" | "swap_rate_out_of_bounds" | null;
+        SwapsCreateQuoteInput: {
+            /** @description The amount on amount_side: a positive decimal of at most six places, no separators. */
+            amount: string;
+            amount_side?: components["schemas"]["SwapsAmountSide"];
+            from_asset: components["schemas"]["SwapsAsset"];
+            route_id: components["schemas"]["SwapsRouteID"];
+            to_asset: components["schemas"]["SwapsAsset"];
+        };
+        SwapsQuoteOutput: {
+            /**
+             * Format: date-time
+             * @description When the quote stops being offered. A swap created from it at or after this instant is refused.
+             */
+            expires_ts: string;
+            /** @description The swap fee, always in USDC: a decimal string at six places. */
+            fee_amount: string;
+            /**
+             * Format: int64
+             * @description The swap fee rate the quote freezes, in basis points of the swap's USDC side.
+             */
+            fee_bps: number;
+            from_asset: components["schemas"]["SwapsAsset"];
+            /** @description The quote's id. The swap create consumes it, once, before expires_ts. */
+            quote_id: string;
+            /** @description The firm all-in exchange rate, to_asset per one from_asset, before the swap fee: a decimal string at eight places. */
+            rate: string;
+            /** @description The amount of to_asset the swap delivers, after the fee when to_asset is USDC: a decimal string at six places. */
+            receive_amount: string;
+            route_id: components["schemas"]["SwapsRouteID"];
+            /** @description The amount of from_asset the swap sends, fee included when from_asset is USDC: a decimal string at six places. */
+            send_amount: string;
+            /** @description How far rate is from 1:1, in basis points, as a decimal string at two places: positive when the business receives less than it sends, before the fee. */
+            spread_bps: string;
+            to_asset: components["schemas"]["SwapsAsset"];
+        };
+        SwapsRoutesOutput: {
+            /** @description Whether the business can swap: its swap money movement type is enabled. When false, routes is empty and every other swap endpoint answers 403 money_movement_type_disabled. */
+            enabled: boolean;
+            /** @description The swap routes, in display order. Empty when enabled is false. */
+            routes: components["schemas"]["SwapsRouteView"][] | null;
+        };
+        SwapsRouteView: {
+            /** @description The assets the route swaps between, in either direction. */
+            assets: components["schemas"]["SwapsAsset"][] | null;
+            /** @description The available balance of each of the route's assets in the business's Go Account, from the ledger: what a swap can send now. */
+            available: components["schemas"]["SwapsAssetAmountView"][] | null;
+            chain: components["schemas"]["SwapsChain"];
+            /**
+             * Format: int64
+             * @description The business's swap fee rate, in basis points of the swap's USDC side, for a swap of min_amount. With size bands a larger swap can pay a different rate; the estimate states the rate for an amount.
+             */
+            fee_bps: number;
+            /** @description The most a swap on this route sends, in the asset sent: a decimal string at six places. */
+            max_amount: string;
+            /** @description The least amount a swap on this route sends, in the asset sent: a decimal string at six places. */
+            min_amount: string;
+            route_id: components["schemas"]["SwapsRouteID"];
+        };
+        SwapsAssetAmountView: {
+            /** @description A decimal string at six places. */
+            amount: string;
+            asset: components["schemas"]["SwapsAsset"];
+        };
+        /** @enum {string} */
+        SwapsChain: "ethereum";
+        SwapsSwapSubmissionOutput: {
+            /** @description The swap's movement. Creation does not mean the swap has completed: read transaction.status. */
+            money_movement_id: string;
+            transaction: components["schemas"]["MoneyMovementsMoneyMovementView"];
+        };
+        SwapsCreateSwapInput: {
+            /** @description The firm quote to execute (POST /money/swap_quotes). A quote executes once, before its expires_ts. */
+            quote_id: string;
+        };
         Page_MoneyMovementsTransferApprovalView: {
             data: components["schemas"]["MoneyMovementsTransferApprovalView"][] | null;
             has_more: boolean;
@@ -10237,6 +10476,53 @@ export interface operations {
             };
         };
     };
+    "money.maintenance.get": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MoneyMovementsBusinessMaintenanceView"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+        };
+    };
     "money.onchain.withdrawals.create": {
         parameters: {
             query?: never;
@@ -10318,6 +10604,368 @@ export interface operations {
             };
         };
     };
+    "money.swap_estimate.get": {
+        parameters: {
+            query: {
+                /** @description The route to swap on (GET /money/swap_routes). */
+                route_id: components["schemas"]["SwapsRouteID"];
+                /** @description The asset sent. */
+                from_asset: components["schemas"]["SwapsAsset"];
+                /** @description The asset received. Must differ from from_asset. */
+                to_asset: components["schemas"]["SwapsAsset"];
+                /** @description The amount on amount_side: a positive decimal of at most six places, no separators. */
+                amount: string;
+                /** @description Which amount is fixed: send (the default) fixes the amount of from_asset sent; receive fixes the amount of to_asset received, and the server solves the least amount sent that delivers it. */
+                amount_side?: components["schemas"]["SwapsAmountSide"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SwapsEstimateOutput"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Service Unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+        };
+    };
+    "money.swap_quotes.create": {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Required client idempotency key; a duplicate submission with the same key is rejected with 409. */
+                "Idempotency-Key": string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["SwapsCreateQuoteInput"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SwapsQuoteOutput"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Service Unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+        };
+    };
+    "money.swap_routes.list": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SwapsRoutesOutput"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+        };
+    };
+    "money.swap_submissions.get": {
+        parameters: {
+            query: {
+                /** @description The original POST /money/swaps request's Idempotency-Key; surrounding whitespace is trimmed before enforcing the 255-character limit. */
+                idempotency_key: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SwapsSwapSubmissionOutput"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+        };
+    };
+    "money.swaps.create": {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Required client idempotency key; a duplicate submission with the same key is rejected with 409. Keep it: GET /money/swap_submissions finds the swap by it. */
+                "Idempotency-Key": string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["SwapsCreateSwapInput"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MoneyMovementsCreateMoneyMovementOutput"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Service Unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+        };
+    };
     "money.test_approvals.rules_get": {
         parameters: {
             query?: never;