@stable_sea/sdk 0.2.14 → 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",
 });
 ```
 
@@ -99,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.
@@ -364,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: {
@@ -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} */
@@ -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"];

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

@@ -686,7 +686,7 @@ export interface paths {
         put?: never;
         /**
          * Accept being the authorized signer
-         * @description The member a request names accepts, from their own session. Only that member can; the request then waits for a compliance operator.
+         * @description The member a request names accepts, from their own session, and submits the identity details Stable Sea must verify for a new authorized signer: citizenship, date of birth, a US Social Security Number or a passport (a United States citizen gives an SSN; anyone else says whether they have a US SSN), and an address. The name comes from the member's record. Only that member can accept; the request then waits for a compliance operator, who reads the details with the SSN or passport number masked and can reveal the whole value, on the record. The details are sealed on the request and are never returned to the business: not to its admins and not in this answer. A body that does not match this schema (a missing field, a wrong type, a value over its length cap) is refused as invalid_field; a detail the schema accepts and the rules refuse (an ITIN, a date of birth that is not a real day or makes the signer younger than 18, a field the identifier class does not allow) is refused as signer_change_invalid. Neither refusal repeats a submitted value.
          */
         post: operations["compliance.signer_changes.accept"];
         delete?: never;
@@ -1103,6 +1103,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/identity/members/{individual_id}/api_keys": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List a member's active API keys
+         * @description Lists the unrevoked Live or Test keys one member of your current business created. Keys authenticate as the business, so they keep working after the member is suspended or removed until you revoke them. Requires api_keys_manage.
+         */
+        get: operations["identity.members.api_keys.list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/identity/members/{individual_id}/rbac": {
         parameters: {
             query?: never;
@@ -1434,7 +1454,7 @@ export interface paths {
         };
         /**
          * List your notifications
-         * @description Returns your supported notifications for the current business, newest first. Use next_cursor for the following page. Includes registered notification types except QuickBooks. Requires a signed-in business session; account and member locks still apply.
+         * @description Returns your supported notifications for the current business, newest first. Use next_cursor for the following page. Bank notices cover US accounts; cross-border payment notices are excluded. Older financial notices without an identifiable account or transaction are omitted. Requires a signed-in business session; account and member locks still apply.
          */
         get: operations["notifications.member_notifications.list"];
         put?: never;
@@ -2341,6 +2361,28 @@ export interface components {
             new_signer_id: string;
             reason: string;
         };
+        ComplianceAcceptSignerChangeBody: {
+            address_city: string;
+            /** @description A country name like those in the KYB form's country list (only presence and length are checked). */
+            address_country: string;
+            /** @description Required when address_country is United States, as a state name from the KYB form's state list. */
+            address_state?: string;
+            address_street: string;
+            address_street_2?: string;
+            address_zip: string;
+            /** @description The signer's country of citizenship, as a country name like those in the KYB form's country list (only presence and length are checked), for example United States. */
+            citizenship: string;
+            /** @description The signer's date of birth, YYYY-MM-DD. The signer must be at least 18 years old. */
+            date_of_birth: string;
+            /** @description Whether the signer has a US Social Security Number: Yes or No, as on the KYB form. Required when citizenship is not United States; refused when it is. */
+            holds_us_ssn?: string;
+            /** @description The country that issued the passport, as a country name like those in the KYB form's country list (only presence and length are checked). */
+            passport_country?: string;
+            /** @description The signer's passport number. Required, with passport_country, when the signer is not a United States citizen and has no US SSN; refused otherwise. */
+            passport_number?: string;
+            /** @description The signer's US Social Security Number. Required when the signer is a United States citizen or has a US SSN; refused otherwise. An ITIN is not accepted. */
+            ssn?: string;
+        };
         IdentityReportUnrecognizedLoginInput: {
             token?: string;
         };
@@ -5267,7 +5309,11 @@ export interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["ComplianceAcceptSignerChangeBody"];
+            };
+        };
         responses: {
             /** @description OK */
             200: {
@@ -5278,6 +5324,15 @@ export interface operations {
                     "application/json": components["schemas"]["ComplianceSignerChangeView"];
                 };
             };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
             /** @description Unauthorized */
             401: {
                 headers: {
@@ -6329,6 +6384,41 @@ export interface operations {
             };
         };
     };
+    "identity.members.api_keys.list": {
+        parameters: {
+            query?: {
+                limit?: number;
+                cursor?: string;
+                environment?: components["schemas"]["CustomerEnvironment"];
+            };
+            header?: never;
+            path: {
+                individual_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Page_CustomerAPIKey"];
+                };
+            };
+            /** @description Error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+        };
+    };
     "identity.members.rbac.get": {
         parameters: {
             query?: never;

package/package.json

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