@stable_sea/sdk 0.2.31 → 0.2.34

package/dist/gen/schema.d.ts

@@ -3296,6 +3296,15 @@ export interface components {
                 [name: string]: unknown;
             };
             content: {
+                /**
+                 * @example {
+                 *       "error": {
+                 *         "type": "authentication_error",
+                 *         "message": "unauthorized",
+                 *         "request_id": "api-server/7hTXDzKxCA-000001"
+                 *       }
+                 *     }
+                 */
                 "application/json": components["schemas"]["Error"];
             };
         };

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

@@ -95,7 +95,7 @@ export interface paths {
         };
         /**
          * Read the business's e-signature enrollment (business)
-         * @description Reports whether the caller accepts their business's MSA by e-signature — the business is enrolled and its allow-list, when it has one, names the caller — the provider this deployment uses, and how the embedded signing page reports progress (protocol and the only allowed message origin). A caller who is not enrolled reads enrolled:false and accepts by click-through. While e-signature is paused on this deployment, an enrolled caller also reads enrolled:false and accepts by click-through, unless a signature request holds the current MSA document named by document_id (or, without document_id, any current MSA document of their business): they keep signing that document by e-signature until the request ends. A document_id that is not one of the business's MSA documents is then 404 document_not_found, as accepting it is. A caller who signs by e-signature while it is not running on this deployment gets 503 — never enrolled:false, because click-through acceptance is refused for them.
+         * @description Reports whether the caller accepts their business's MSA by e-signature — the business is enrolled and its allow-list, when it has one, names the caller — the provider this deployment uses, and how the embedded signing page reports progress (protocol and the only allowed message origin). A caller who is not enrolled reads enrolled:false and accepts by click-through. While e-signature is paused on this deployment, an enrolled caller also reads enrolled:false and accepts by click-through, unless a signature request holds the current MSA document named by document_id (or, without document_id, any current MSA document of their business): they keep signing that document by e-signature until the request ends. A document_id that is not one of the business's MSA documents is then 404 document_not_found, as accepting it is. A caller who signs by e-signature while it is not running on this deployment gets 503 — never enrolled:false, because click-through acceptance is refused for them. custody_contracts_enrolled says whether the caller signs their business's custody contracts by e-signature, in which case signing one by click-through is refused (409 esign_required).
          */
         get: operations["compliance.esign.enrollment.get"];
         put?: never;
@@ -120,8 +120,8 @@ export interface paths {
         get: operations["compliance.esign.envelopes.list"];
         put?: never;
         /**
-         * Start or resume signing the MSA (business)
-         * @description Composes (or resumes) the calling member's e-signature envelope for the business's live MSA document and returns it, plus a one-time embedded signing session when one can be issued. Requires e-sign enrollment (400 esign_not_enrolled), the signer's authority attestation and title (400 esign_authority_attestation_required). An envelope another member started answers 409 esign_signer_conflict without a session; resuming the caller's own envelope with a title other than the one already placed on its document answers 409 esign_title_conflict; a document the caller cannot address answers 404 document_not_found; an agreement that changed while signing was starting answers 409 esign_source_changed; a new envelope while this month's envelope count is at or above the platform's hard cap answers 409 esign_envelope_cap_reached (nothing is created or sent; resuming an envelope already started is not refused); a paused deployment answers 503, and an enrolled business on a deployment where e-signature is unavailable answers 503.
+         * Start or resume signing an agreement (business)
+         * @description Composes (or resumes) the calling member's e-signature envelope and returns it, plus a one-time embedded signing session when one can be issued. With `purpose` `msa` it signs the business's live MSA document named by `document_id`. With `purpose` `custody_contract` it signs the custody contract named by `contract_type`; the platform resolves the contract's document itself, so `document_id` must be absent. A request whose fields do not match its purpose, including an `msa` request without `document_id`, answers 400 `esign_purpose_invalid` with `param` naming the field. Requires e-sign enrollment (400 `esign_not_enrolled`, which is also the answer for `custody_contract` wherever custody contracts are not signed by e-signature), and the signer's authority attestation and title (400 `esign_authority_attestation_required`). An envelope another member started answers 409 `esign_signer_conflict` without a session; resuming the caller's own envelope with a title other than the one already placed on its document answers 409 `esign_title_conflict`; a document the caller cannot address answers 404 `document_not_found`; an agreement that changed while signing was starting, or a custody contract the business already signed, answers 409 `esign_source_changed`; a new envelope while this month's envelope count is at or above the platform's hard cap answers 409 `esign_envelope_cap_reached` (nothing is created or sent; resuming an envelope already started is not refused); a paused deployment answers 503, and an enrolled business on a deployment where e-signature is unavailable answers 503.
          */
         post: operations["compliance.esign.envelopes.create"];
         delete?: never;
@@ -1735,7 +1735,7 @@ export interface paths {
         put?: never;
         /**
          * Sign a custody contract on behalf of the session's group
-         * @description Records the user's signature on the contract template identified by contract_type.
+         * @description Records the user's signature on the contract template identified by contract_type. An unknown contract_type is 400 invalid_contract_type. A click-through that e-signature decides is refused with 409 esign_required: while an e-signature request for that contract is in progress or has been signed, or while the user signs their business's custody contracts by e-signature (custody_contracts_enrolled on GET /compliance/esign/enrollment). The user then signs, or has signed, through the e-signature request instead.
          */
         post: operations["money.contracts.sign"];
         delete?: never;
@@ -2568,6 +2568,7 @@ export interface components {
             mime_type?: string;
         };
         EsignEnrollmentOutput: {
+            custody_contracts_enrolled: boolean;
             embed: components["schemas"]["EsignEmbedOutput"];
             enrolled: boolean;
             provider: string;
@@ -2586,6 +2587,7 @@ export interface components {
         };
         EsignEnvelopeView: {
             artifacts: components["schemas"]["EsignEnvelopeArtifactsView"];
+            contract_type?: components["schemas"]["EsignCustodyContractType"];
             /** Format: date-time */
             created_ts: string;
             document: components["schemas"]["EsignEnvelopeDocumentView"];
@@ -2602,6 +2604,11 @@ export interface components {
             executed_document: boolean;
             provider_certificate: boolean;
         };
+        /**
+         * @description A custody contract: custody_sa (the custodial services agreement) or trade_sa (the electronic trading agreement). On an envelope it names the contract a custody_contract envelope signs, and is absent when purpose is msa. On a create it is required when purpose is custody_contract and must be absent when purpose is msa.
+         * @enum {string}
+         */
+        EsignCustodyContractType: "custody_sa" | "trade_sa";
         EsignEnvelopeDocumentView: {
             associated_entity: string;
             customer_legal_name?: string;
@@ -2610,7 +2617,7 @@ export interface components {
             version: string;
         };
         /** @enum {string} */
-        EsignEnvelopePurpose: "msa";
+        EsignEnvelopePurpose: "msa" | "custody_contract";
         EsignEnvelopeSignerView: {
             display_name: string;
             individual_id?: string | null;
@@ -2623,7 +2630,10 @@ export interface components {
         };
         /** @enum {string} */
         EsignSignerStatus: "pending" | "viewed" | "signed" | "declined" | "reassigned";
-        /** @enum {string} */
+        /**
+         * @description Lifecycle of the envelope. preparing: being sent to the provider. awaiting_signatures: out for signature. archiving: signed; the executed copy and evidence are being stored. needs_repair: signed or sent, waiting on an operator; the signature stands. executed: signed and durably stored; the agreement it signs is accepted. declined/expired/voided/failed: ended without a signature; start a new envelope.
+         * @enum {string}
+         */
         EsignEnvelopeStatus: "preparing" | "awaiting_signatures" | "partially_signed" | "archiving" | "needs_repair" | "executed" | "declined" | "expired" | "voided" | "failed";
         EsignEnvelopeVerificationView: {
             certificate_sha256?: string | null;
@@ -2632,12 +2642,14 @@ export interface components {
         };
         EsignCreateEnvelopeInput: {
             authority_attestation: boolean;
-            document_id: string;
+            contract_type?: components["schemas"]["EsignCustodyContractType"];
+            document_id?: string;
             purpose: components["schemas"]["EsignEnvelopePurpose"];
             title: string;
         };
         EsignCreateEnvelopeOutput: {
             artifacts: components["schemas"]["EsignEnvelopeArtifactsView"];
+            contract_type?: components["schemas"]["EsignCustodyContractType"];
             /** Format: date-time */
             created_ts: string;
             document: components["schemas"]["EsignEnvelopeDocumentView"];
@@ -3806,6 +3818,8 @@ export interface components {
             /** Format: base64 */
             contract_pdf_contents?: string;
             contract_type?: string;
+            /** @description The template version to sign: the hex SHA-256 of the template PDF. An e-signature envelope for this contract signs it when its document version equals this value. */
+            version: string;
         };
         CustodyDownloadContractOutput: {
             /** Format: base64 */
@@ -3831,6 +3845,12 @@ export interface components {
             created_by: string;
             /** Format: date-time */
             created_ts: string;
+            /**
+             * Format: date-time
+             * @description Estimated time the trade of a movement with execution=after_funding is placed, while it has not been placed yet and that time has not passed. An estimate, not a commitment.
+             */
+            estimated_execution_ts?: string;
+            execution?: components["schemas"]["MoneyMovementsMovementExecution"];
             /** Format: date-time */
             failed_ts?: string;
             fee?: components["schemas"]["MoneyfmtMoneyAmountView"];
@@ -3862,6 +3882,8 @@ export interface components {
             transaction_count: number;
             type: string;
         };
+        /** @enum {string} */
+        MoneyMovementsMovementExecution: "after_funding";
         MoneyMovementsTransactionSideView: {
             amount: components["schemas"]["MoneyfmtMoneyAmountView"];
             /** @description Whether amount is still an estimate — the leg's quoted subtotal, carried because the leg's figure is not final. True means the figure can still move and must be presented as an estimate rather than as a settled one. False means it can no longer change, either because the leg reached a terminal state or because it carries the figure the customer named at order entry (a fund buy's dollars, a fund sell's shares); it does not promise the figure was observed. */
@@ -4160,8 +4182,14 @@ export interface components {
             amount_usd?: string;
             amount_usd_view?: components["schemas"]["MoneyfmtMoneyAmountView"];
             approval_preview?: components["schemas"]["TradesBuyApprovalPreview"];
+            /**
+             * Format: date-time
+             * @description Estimated time an execution=after_funding order is placed, measured from this quote. An estimate, not a commitment.
+             */
+            estimated_execution_ts?: string;
             estimated_quantity?: string;
             estimated_quantity_view?: components["schemas"]["MoneyfmtMoneyAmountView"];
+            execution?: components["schemas"]["MoneyMovementsMovementExecution"];
             /** Format: date-time */
             expires_ts?: string;
             express_buy?: components["schemas"]["TradesExpressBuyQuote"];
@@ -10080,6 +10108,24 @@ export interface operations {
                     "application/json": components["schemas"]["CustodySignContractAck"];
                 };
             };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HttputilAPIError"];
+                };
+            };
             /** @description Error response. */
             default: {
                 headers: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stable_sea/sdk",
-  "version": "0.2.31",
+  "version": "0.2.34",
   "type": "module",
   "sideEffects": false,
   "files": [
@@ -41,7 +41,7 @@
     "vitest": "5.0.4"
   },
   "overrides": {
-    "js-yaml": "^5.4.3",
+    "js-yaml": "^4.3.2",
     "nanoid": "^3.3.17",
     "source-map-js": "^1.2.2"
   }