@stable_sea/sdk 0.2.13 → 0.2.18

package/README.md

@@ -21,7 +21,7 @@ import { createStableSeaClient } from "@stable_sea/sdk";
 const client = createStableSeaClient({
   apiKey: process.env.STABLE_SEA_API_KEY!,
   baseUrl: process.env.STABLE_SEA_BASE_URL!,
-  version: "2026-10-11",
+  version: "2026-10-15",
 });
 ```
 
@@ -55,8 +55,9 @@ settlement; instant orders are refused in both production and sandbox.
 
 ## Member administration and personal actions
 
-Use `createStableSeaSessionClient` for your profile and security, team and API-key
-administration, notifications, preferences and business support messages. It uses
+Use `createStableSeaSessionClient` for onboarding, legal documents, your profile
+and security, team and API-key administration, notifications, preferences and
+business support messages. It uses
 the native sign-in, MFA and business-selection flow,
 not a Live or Test API key. Use `https://api.stablesea.com`; the isolated
 Test-key Sandbox does not serve member sessions.
@@ -98,6 +99,12 @@ invitee's email-link token; administrators cannot accept on their behalf.
 Member grants and activation use existing business permissions. Policy settings
 retain their separate launch gate.
 
+Read a member's active keys at
+`GET /identity/members/{individual_id}/api_keys`, selecting `environment: "live"`
+or `"test"`. Suspending or removing the member leaves those business keys working;
+revoke unwanted keys explicitly through the existing key-revocation operation.
+The same API-key management permission applies.
+
 Manage Live and Test credentials at `/identity/api_keys`. Use an explicit scope
 list and a unique issuance idempotency key. Test lifecycle operations have no
 extra fresh two-factor prompt; Live operations retain their existing protection.
@@ -113,6 +120,37 @@ advisory, not proof of authentication.
 Generated types are exported as `SessionPaths`, `SessionOperations` and
 `SessionComponents`; internal operator and excluded product operations are omitted.
 
+## Business onboarding and documents
+
+Use the member client before issuing an API key. Signup uses the existing
+business-email/OTP flow. After account and authenticator setup, sign in and select
+your business using the same session flow as Terminal.
+
+Read `/onboarding/status` and `/compliance/kyb/fields` to discover the current
+requirements and saved answers. Review registry proposals before confirming
+prefilled answers. Draft writes retain their native revision checks: send the
+field's current `answer_revision` as `expected_answer_revision`, keep the returned
+revision, and reload/review a conflict before another save. Checklist uploads and
+account documents use the existing base64 document operations and limits.
+
+Read pending MSAs at `/compliance/msa/terms`, retrieve each document, and retain
+its version for click-through acceptance. Read agreements before the actual
+authorized signer consents. MSA enrollment
+chooses the existing click-through or embedded-signature workflow. An envelope's
+`executed` status and archived artifacts establish completion; issuing a signing
+URL does not. W-9 signing binds the reviewed prepared-form checksum. Custody
+contract signing requires an explicit `Idempotency-Key`. Provider enrollment,
+business terms, signer authority and compliance review remain enforced; this
+client does not activate a feature or sign as a machine credential. Present the
+[WisdomTree supplemental terms](https://www.wisdomtreeconnect.com/stable-sea-supplemental-terms-of-use)
+before recording the member's explicit consent at `/money/treasury/terms`;
+that route's GET returns acceptance metadata, not the document.
+
+See the [onboarding guide](https://docs.stablesea.com/api/#onboarding) for the
+workflow, field-value encoding and document handling, and the
+[member reference](https://docs.stablesea.com/api/member-reference/) for request
+shapes and native retry rules.
+
 ## Idempotent writes
 
 Create one mutation handle for one logical write. Its `POST` method always sends
@@ -332,6 +370,21 @@ with `client.DELETE("/v1/bank_accounts/{id}")`, without a body or idempotency ke
 Read bank and wallet operation `status` instead of `state`. Retrieve issued
 statement content with `GET /v1/statements/{id}`; the `/content` route is retired.
 
-The HTTP request pin is `2026-10-11`. The retired pin returns
+The HTTP request pin is `2026-10-15`. The retired pin returns
 `400 unsupported_api_version`. Existing API keys remain valid; stored key and
 thin-event/webhook versions are preserved.
+
+Fund documents are part of `GET /v1/securities`: use
+`details.content.disclosures` for issuer fund-page and approved Terminal trading
+disclosure HTML, including yield definitions, transaction roles and fee
+applicability. Titles identify the context, and each fund's risk language is
+preserved. Use
+`details.content.prospectus_url` for the shared Terminal prospectus link. The
+link may open the issuer’s official regulatory-reports page. Details and links
+can be null and disclosures can be empty when unavailable.
+These blocks supplement current quotes, fees and financial controls.
+
+Bank registration and reads support US accounts only. Non-US banks and
+cross-border Payments/Treasury operations are intentionally excluded. Update to
+the latest SDK for the current HTTP contract; credential and webhook record
+versions are unchanged.

package/dist/gen/schema.d.ts

@@ -179,7 +179,7 @@ export interface paths {
         };
         /**
          * List bank accounts
-         * @description Lists saved US and Mexican bank accounts, newest first by created_ts, then ID. Requires money:read. Account numbers and holder identity are masked unless the key also has money:bank_accounts_sensitive_read. Institution, routing and postal address fields follow the same visibility as Terminal.
+         * @description Lists saved US bank accounts, newest first by created_ts, then ID. Requires money:read. Account numbers and holder identity are masked unless the key also has money:bank_accounts_sensitive_read. Institution, routing and postal address fields follow the same visibility as Terminal.
          *
          *     Use either starting_after or ending_before with a bank account ID. limit defaults to 10 and cannot exceed 100. An unknown or removed cursor returns an error. Newly added or changed accounts can briefly return 503 before updated details are available; retry the read.
          */
@@ -187,7 +187,7 @@ export interface paths {
         put?: never;
         /**
          * Register a bank account
-         * @description Registers a US or Mexican bank account using Terminal's existing validation and screening. Provide country and the matching us_bank_account or mx_bank_account details. Requires money:bank_accounts_write and an Idempotency-Key. Poll the returned operation, then retrieve its bank_account with money:read. Registration alone does not enable the account or make it eligible for funding or payouts.
+         * @description Registers a US bank account using Terminal's existing validation and screening. Set country to US and provide us_bank_account details. Non-US bank accounts and cross-border payments are not supported. Requires money:bank_accounts_write and an Idempotency-Key. Poll the returned operation, then retrieve its bank_account with money:read. Registration alone does not enable the account or make it eligible for funding or payouts.
          */
         post: operations["bank_accounts.create"];
         delete?: never;
@@ -1212,17 +1212,16 @@ export interface components {
             /** @enum {string} */
             beneficiary_type: "self" | "third_party";
             /** @enum {string} */
-            country: "US" | "MX";
+            country: "US";
             /** Format: date-time */
             created_ts: string;
             /** @enum {string} */
-            currency: "USD" | "MXN";
+            currency: "USD";
             /** @description True when account numbers and holder identity are masked. Full details require money:bank_accounts_sensitive_read in addition to money:read. */
             details_masked: boolean;
             id: string;
             /** @description False for an isolated simulated bank account. */
             livemode: boolean;
-            mx_bank_account?: components["schemas"]["MXBankAccountDetails"];
             /** @enum {string} */
             object: "bank_account";
             /**
@@ -1230,7 +1229,7 @@ export interface components {
              * @enum {string}
              */
             status: "enabled" | "disabled";
-            us_bank_account?: components["schemas"]["USBankAccountDetails"];
+            us_bank_account: components["schemas"]["USBankAccountDetails"];
         };
         BankAccountAddress: {
             city: string;
@@ -1253,9 +1252,8 @@ export interface components {
              */
             beneficiary_type?: "self" | "third_party" | null;
             /** @enum {string} */
-            country: "US" | "MX";
-            mx_bank_account?: components["schemas"]["MXBankAccountCreateDetails"];
-            us_bank_account?: components["schemas"]["USBankAccountCreateDetails"];
+            country: "US";
+            us_bank_account: components["schemas"]["USBankAccountCreateDetails"];
         };
         BankAccountDeleted: {
             /** @enum {boolean} */
@@ -1608,29 +1606,13 @@ export interface components {
             observed_ts: string;
         };
         /** @enum {string} */
-        HTTPAPIVersion: "2026-10-11";
+        HTTPAPIVersion: "2026-10-15";
         List: {
             data: components["schemas"]["Resource"][];
             has_more: boolean;
             /** @enum {string} */
             object: "list";
         };
-        MXBankAccountCreateDetails: {
-            account_holder_first_name: string;
-            account_holder_last_name: string;
-            clabe: string;
-            /** @description Optional RFC or CURP, validated by the existing recipient rules. */
-            holder_identifier?: string;
-            legal_entity_name: string;
-        };
-        MXBankAccountDetails: {
-            account_holder_first_name: string;
-            account_holder_last_name: string;
-            clabe: string;
-            /** @description Account holder RFC or CURP. Omitted when unavailable; masked unless full details are permitted. */
-            holder_identifier?: string;
-            legal_entity_name: string;
-        };
         MarketPricePoint: {
             close_usd: string;
             /** Format: date-time */
@@ -2085,7 +2067,13 @@ export interface components {
         };
         SecurityContent: {
             description_html: string;
+            /** @description Issuer fund-page and approved trading disclosures. Titles identify order, review and Express buy contexts; fund-specific applicability is preserved. */
             disclosures: components["schemas"]["SecurityDisclosure"][];
+            /**
+             * Format: uri
+             * @description Issuer prospectus or official prospectus and regulatory-reports page, shared with Terminal. The link may open a document portal rather than a PDF. Null when unavailable.
+             */
+            prospectus_url: string | null;
             why_fund_html: string;
         };
         SecurityDetails: {
@@ -2284,7 +2272,7 @@ export interface components {
             /** @enum {string} */
             status: "completed" | "pending" | "failed";
             /** @enum {string} */
-            type: "ach_offramp" | "ach_onramp" | "adjustment" | "buy_fund_token" | "buy_fund_token_return" | "buy_fund_token_return_sweep" | "deposit_hold" | "deposit_return" | "deposit_reversal" | "fund_cash_subscription" | "fund_dividend_payout" | "fund_distribution_payout" | "fund_gas_tank" | "fund_xlm_reserve" | "gas_tank_refill" | "gas_wallet_funding" | "go_account_conversion" | "go_account_custodial_transfer" | "go_account_external_send" | "held_deposit_release" | "onchain_deposit" | "onchain_withdrawal" | "ramp_fee_refund" | "reclassification" | "sell_fund_token" | "sell_fund_token_return" | "trade_order" | "treasury_booking" | "treasury_wire_credit" | "wire_offramp" | "wire_onramp";
+            type: "ach_offramp" | "ach_onramp" | "adjustment" | "buy_fund_token" | "buy_fund_token_return" | "buy_fund_token_return_sweep" | "cash_home_transfer" | "deposit_hold" | "deposit_return" | "deposit_reversal" | "fund_cash_subscription" | "fund_dividend_payout" | "fund_distribution_payout" | "fund_gas_tank" | "fund_xlm_reserve" | "gas_tank_refill" | "gas_wallet_funding" | "go_account_conversion" | "go_account_custodial_transfer" | "go_account_external_send" | "held_deposit_release" | "onchain_deposit" | "onchain_withdrawal" | "ramp_fee_refund" | "reclassification" | "sell_fund_token" | "sell_fund_token_return" | "trade_order" | "treasury_booking" | "treasury_wire_credit" | "wire_offramp" | "wire_onramp";
             withdrawal?: components["schemas"]["StatementWithdrawal"];
         };
         StatementGeneration: {
@@ -2294,7 +2282,7 @@ export interface components {
              * @description Reason processing failed. Correct the cause before submitting a new request with a new idempotency key.
              * @enum {string}
              */
-            failure_code?: "permission_denied" | "api_key_revoked" | "business_locked" | "terms_acceptance_required" | "api_access_disabled" | "statement_ineligible" | "invalid_statement_month" | "statement_generation_refused" | "statement_processing_unavailable";
+            failure_code?: "permission_denied" | "api_key_revoked" | "business_locked" | "business_archived" | "terms_acceptance_required" | "api_access_disabled" | "statement_ineligible" | "invalid_statement_month" | "statement_generation_refused" | "statement_processing_unavailable";
             id: string;
             livemode: boolean;
             /** @enum {string} */
@@ -2433,7 +2421,7 @@ export interface components {
              * @description What the movement is. The whole vocabulary a transaction can carry is published; a business only ever sees the members its own activity produces. Pay-ins and payouts are never served on this API.
              * @enum {string}
              */
-            type: "ach_offramp" | "ach_onramp" | "adjustment" | "buy_fund_token" | "buy_fund_token_return" | "buy_fund_token_return_sweep" | "deposit_hold" | "deposit_return" | "deposit_reversal" | "fund_cash_subscription" | "fund_dividend_payout" | "fund_distribution_payout" | "fund_gas_tank" | "fund_xlm_reserve" | "gas_tank_refill" | "gas_wallet_funding" | "go_account_conversion" | "go_account_custodial_transfer" | "go_account_external_send" | "held_deposit_release" | "onchain_deposit" | "onchain_withdrawal" | "ramp_fee_refund" | "reclassification" | "sell_fund_token" | "sell_fund_token_return" | "trade_order" | "treasury_booking" | "treasury_wire_credit" | "wire_offramp" | "wire_onramp";
+            type: "ach_offramp" | "ach_onramp" | "adjustment" | "buy_fund_token" | "buy_fund_token_return" | "buy_fund_token_return_sweep" | "cash_home_transfer" | "deposit_hold" | "deposit_return" | "deposit_reversal" | "fund_cash_subscription" | "fund_dividend_payout" | "fund_distribution_payout" | "fund_gas_tank" | "fund_xlm_reserve" | "gas_tank_refill" | "gas_wallet_funding" | "go_account_conversion" | "go_account_custodial_transfer" | "go_account_external_send" | "held_deposit_release" | "onchain_deposit" | "onchain_withdrawal" | "ramp_fee_refund" | "reclassification" | "sell_fund_token" | "sell_fund_token_return" | "trade_order" | "treasury_booking" | "treasury_wire_credit" | "wire_offramp" | "wire_onramp";
         };
         TransactionAssetChange: {
             /** @description The signed net change to the business's settled holdings of this asset, in the asset's own units. Negative amounts decrease holdings; positive amounts increase them. Net of the ledger's fees and taxes, on the same basis /v1/balances reports. For a business with no pay-ins or payouts, summing an asset's amounts across every transaction — not only the completed ones — gives the movement in its settled balance. Pay-ins and payouts are not served on this API but still move /v1/balances, so a business with payments cannot reconcile its balance from transactions alone. */
@@ -2493,7 +2481,7 @@ export interface components {
              * @description What the movement is. The whole vocabulary a transaction can carry is published; a business only ever sees the members its own activity produces. Pay-ins and payouts are never served on this API.
              * @enum {string}
              */
-            type: "ach_offramp" | "ach_onramp" | "adjustment" | "buy_fund_token" | "buy_fund_token_return" | "buy_fund_token_return_sweep" | "deposit_hold" | "deposit_return" | "deposit_reversal" | "fund_cash_subscription" | "fund_dividend_payout" | "fund_distribution_payout" | "fund_gas_tank" | "fund_xlm_reserve" | "gas_tank_refill" | "gas_wallet_funding" | "go_account_conversion" | "go_account_custodial_transfer" | "go_account_external_send" | "held_deposit_release" | "onchain_deposit" | "onchain_withdrawal" | "ramp_fee_refund" | "reclassification" | "sell_fund_token" | "sell_fund_token_return" | "trade_order" | "treasury_booking" | "treasury_wire_credit" | "wire_offramp" | "wire_onramp";
+            type: "ach_offramp" | "ach_onramp" | "adjustment" | "buy_fund_token" | "buy_fund_token_return" | "buy_fund_token_return_sweep" | "cash_home_transfer" | "deposit_hold" | "deposit_return" | "deposit_reversal" | "fund_cash_subscription" | "fund_dividend_payout" | "fund_distribution_payout" | "fund_gas_tank" | "fund_xlm_reserve" | "gas_tank_refill" | "gas_wallet_funding" | "go_account_conversion" | "go_account_custodial_transfer" | "go_account_external_send" | "held_deposit_release" | "onchain_deposit" | "onchain_withdrawal" | "ramp_fee_refund" | "reclassification" | "sell_fund_token" | "sell_fund_token_return" | "trade_order" | "treasury_booking" | "treasury_wire_credit" | "wire_offramp" | "wire_onramp";
         };
         TransactionFeeReturns: {
             original_transaction_id: string | null;
@@ -2712,7 +2700,7 @@ export interface components {
                 "application/json": components["schemas"]["Error"];
             };
         };
-        /** @description The credential lacks the required permission or the operation is unavailable to this business. */
+        /** @description The credential lacks the required permission or the operation is unavailable to this business. Two codes refuse every request a genuine key makes: platform_inactive (API access is not active in this environment) and business_archived (the business is archived; its keys work again once it is unarchived). */
         Error403: {
             headers: {
                 "X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];