@stable_sea/sdk 0.2.12 → 0.2.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -5
- package/dist/gen/schema.d.ts +3 -3
- package/dist/gen/session-schema.d.ts +6931 -304
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -53,10 +53,12 @@ keys and rotations reuse that data.
|
|
|
53
53
|
WTGXX supports standard and instant settlement. FLTTX supports standard
|
|
54
54
|
settlement; instant orders are refused in both production and sandbox.
|
|
55
55
|
|
|
56
|
-
## Member
|
|
56
|
+
## Member administration and personal actions
|
|
57
57
|
|
|
58
|
-
Use `createStableSeaSessionClient` for
|
|
59
|
-
|
|
58
|
+
Use `createStableSeaSessionClient` for onboarding, legal documents, your profile
|
|
59
|
+
and security, team and API-key administration, notifications, preferences and
|
|
60
|
+
business support messages. It uses
|
|
61
|
+
the native sign-in, MFA and business-selection flow,
|
|
60
62
|
not a Live or Test API key. Use `https://api.stablesea.com`; the isolated
|
|
61
63
|
Test-key Sandbox does not serve member sessions.
|
|
62
64
|
|
|
@@ -74,21 +76,75 @@ console.log(feed.data.data);
|
|
|
74
76
|
```
|
|
75
77
|
|
|
76
78
|
Node.js fetch does not retain cookies automatically. Supply your authenticated
|
|
77
|
-
transport
|
|
79
|
+
transport. Call the typed sign-in and refresh operations explicitly; the client
|
|
80
|
+
does not perform authentication, cookie storage or retries automatically.
|
|
78
81
|
Existing login MFA, business membership, locks and permissions remain in force.
|
|
79
82
|
Member requests do not use the dated financial API contract header.
|
|
80
83
|
|
|
81
84
|
Member writes use `member.POST`, with each native operation's retry behavior.
|
|
82
|
-
They have no financial `mutation()` helper
|
|
85
|
+
They have no financial `mutation()` helper. Key creation and rotation require
|
|
86
|
+
an `Idempotency-Key`; other operations retain their documented native retry
|
|
87
|
+
behavior. After an
|
|
83
88
|
uncertain message send, match the returned `id` in the thread against the
|
|
84
89
|
`message_id` you sent before resending;
|
|
85
90
|
repeated sends can repeat notifications. Contact submissions must not retry
|
|
86
91
|
automatically. See the [member guide](https://docs.stablesea.com/api/#member-sessions)
|
|
87
92
|
for sign-in, session lifecycle and attachment retrieval, and the
|
|
88
93
|
[member reference](https://docs.stablesea.com/api/member-reference/) for fields.
|
|
94
|
+
|
|
95
|
+
List members at `GET /identity/members` and manage invitations at
|
|
96
|
+
`/identity/members/invites`. Creation returns invitation details, never the
|
|
97
|
+
redemption token delivered to the invitee. Invitation acceptance uses the
|
|
98
|
+
invitee's email-link token; administrators cannot accept on their behalf.
|
|
99
|
+
Member grants and activation use existing business permissions. Policy settings
|
|
100
|
+
retain their separate launch gate.
|
|
101
|
+
|
|
102
|
+
Manage Live and Test credentials at `/identity/api_keys`. Use an explicit scope
|
|
103
|
+
list and a unique issuance idempotency key. Test lifecycle operations have no
|
|
104
|
+
extra fresh two-factor prompt; Live operations retain their existing protection.
|
|
105
|
+
Key management requires the same permission as Terminal and never broadens an
|
|
106
|
+
existing credential's scopes implicitly.
|
|
107
|
+
|
|
108
|
+
Native refresh and extension retain their existing `Success` and `Message`
|
|
109
|
+
response keys. HTTP 200 with `Success: false` is a refusal. Sign-out returns an
|
|
110
|
+
empty HTTP 200 after durable revocation and cookie clearing. Preserve the refresh
|
|
111
|
+
cookie's `/platform_identity_api/auth/token` path; the session countdown is
|
|
112
|
+
advisory, not proof of authentication.
|
|
113
|
+
|
|
89
114
|
Generated types are exported as `SessionPaths`, `SessionOperations` and
|
|
90
115
|
`SessionComponents`; internal operator and excluded product operations are omitted.
|
|
91
116
|
|
|
117
|
+
## Business onboarding and documents
|
|
118
|
+
|
|
119
|
+
Use the member client before issuing an API key. Signup uses the existing
|
|
120
|
+
business-email/OTP flow. After account and authenticator setup, sign in and select
|
|
121
|
+
your business using the same session flow as Terminal.
|
|
122
|
+
|
|
123
|
+
Read `/onboarding/status` and `/compliance/kyb/fields` to discover the current
|
|
124
|
+
requirements and saved answers. Review registry proposals before confirming
|
|
125
|
+
prefilled answers. Draft writes retain their native revision checks: send the
|
|
126
|
+
field's current `answer_revision` as `expected_answer_revision`, keep the returned
|
|
127
|
+
revision, and reload/review a conflict before another save. Checklist uploads and
|
|
128
|
+
account documents use the existing base64 document operations and limits.
|
|
129
|
+
|
|
130
|
+
Read pending MSAs at `/compliance/msa/terms`, retrieve each document, and retain
|
|
131
|
+
its version for click-through acceptance. Read agreements before the actual
|
|
132
|
+
authorized signer consents. MSA enrollment
|
|
133
|
+
chooses the existing click-through or embedded-signature workflow. An envelope's
|
|
134
|
+
`executed` status and archived artifacts establish completion; issuing a signing
|
|
135
|
+
URL does not. W-9 signing binds the reviewed prepared-form checksum. Custody
|
|
136
|
+
contract signing requires an explicit `Idempotency-Key`. Provider enrollment,
|
|
137
|
+
business terms, signer authority and compliance review remain enforced; this
|
|
138
|
+
client does not activate a feature or sign as a machine credential. Present the
|
|
139
|
+
[WisdomTree supplemental terms](https://www.wisdomtreeconnect.com/stable-sea-supplemental-terms-of-use)
|
|
140
|
+
before recording the member's explicit consent at `/money/treasury/terms`;
|
|
141
|
+
that route's GET returns acceptance metadata, not the document.
|
|
142
|
+
|
|
143
|
+
See the [onboarding guide](https://docs.stablesea.com/api/#onboarding) for the
|
|
144
|
+
workflow, field-value encoding and document handling, and the
|
|
145
|
+
[member reference](https://docs.stablesea.com/api/member-reference/) for request
|
|
146
|
+
shapes and native retry rules.
|
|
147
|
+
|
|
92
148
|
## Idempotent writes
|
|
93
149
|
|
|
94
150
|
Create one mutation handle for one logical write. Its `POST` method always sends
|
package/dist/gen/schema.d.ts
CHANGED
|
@@ -2284,7 +2284,7 @@ export interface components {
|
|
|
2284
2284
|
/** @enum {string} */
|
|
2285
2285
|
status: "completed" | "pending" | "failed";
|
|
2286
2286
|
/** @enum {string} */
|
|
2287
|
-
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";
|
|
2287
|
+
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";
|
|
2288
2288
|
withdrawal?: components["schemas"]["StatementWithdrawal"];
|
|
2289
2289
|
};
|
|
2290
2290
|
StatementGeneration: {
|
|
@@ -2433,7 +2433,7 @@ export interface components {
|
|
|
2433
2433
|
* @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.
|
|
2434
2434
|
* @enum {string}
|
|
2435
2435
|
*/
|
|
2436
|
-
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";
|
|
2436
|
+
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";
|
|
2437
2437
|
};
|
|
2438
2438
|
TransactionAssetChange: {
|
|
2439
2439
|
/** @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 {
|
|
|
2493
2493
|
* @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.
|
|
2494
2494
|
* @enum {string}
|
|
2495
2495
|
*/
|
|
2496
|
-
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";
|
|
2496
|
+
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";
|
|
2497
2497
|
};
|
|
2498
2498
|
TransactionFeeReturns: {
|
|
2499
2499
|
original_transaction_id: string | null;
|