@stable_sea/sdk 0.2.13 → 0.2.14

package/README.md

@@ -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.
@@ -113,6 +114,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

package/dist/gen/schema.d.ts

@@ -2284,7 +2284,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: {
@@ -2433,7 +2433,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 +2493,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;