@dynamic-labs/sdk-api 0.129.0 → 0.130.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/sdk-api",
-  "version": "0.129.0",
+  "version": "0.130.0",
   "author": "Dynamic Labs",
   "license": "Apache-2.0",
   "publishConfig": {

package/src/apis/SDKApi.d.ts

@@ -1768,12 +1768,12 @@ export interface YieldVaultWithdrawOptionsRequest {
  */
 export declare class SDKApi extends runtime.BaseAPI {
     /**
-     * Sets the source wallet address and chain on an initiated flow and mints the capability sessionToken used to drive the rest of the lifecycle. No API key or token is required (the browser has neither at this point) — the endpoint is gated by the flow still being initiated and by CORS. At most one live token exists per flow at a time. When re-attaching from the signing state, the existing session token must be supplied to prove the caller is the original signer.
+     * Sets the source wallet address and chain on a flow and mints the capability sessionToken used to drive the rest of the lifecycle. No API key or token is required (the browser has neither at this point) — the endpoint is gated by the flow\'s state and by CORS. A source can be attached while the flow is initiated, source_attached, quoted or signing, so a payer can switch source before broadcasting. Unlike quote, prepare, broadcast and cancel, which always require the session token, attach needs no token for the first attach or while the flow is source_attached or quoted. From signing, the current session token must be supplied (X-Dynamic-Flow-Session-Token) to prove the caller is the original signer; otherwise the request is rejected with 403 session_token_invalid. Once the flow has been broadcasted or source_detected, or has reached a terminal state, the request is rejected with 409 flow_invalid_transition. Each attach mints a new session token and invalidates the previous one, so at most one live token exists per flow at a time.
      * Attach a source to a flow and mint a session token
      */
     attachFlowSourceRaw(requestParameters: AttachFlowSourceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FlowSourceResponse>>;
     /**
-     * Sets the source wallet address and chain on an initiated flow and mints the capability sessionToken used to drive the rest of the lifecycle. No API key or token is required (the browser has neither at this point) — the endpoint is gated by the flow still being initiated and by CORS. At most one live token exists per flow at a time. When re-attaching from the signing state, the existing session token must be supplied to prove the caller is the original signer.
+     * Sets the source wallet address and chain on a flow and mints the capability sessionToken used to drive the rest of the lifecycle. No API key or token is required (the browser has neither at this point) — the endpoint is gated by the flow\'s state and by CORS. A source can be attached while the flow is initiated, source_attached, quoted or signing, so a payer can switch source before broadcasting. Unlike quote, prepare, broadcast and cancel, which always require the session token, attach needs no token for the first attach or while the flow is source_attached or quoted. From signing, the current session token must be supplied (X-Dynamic-Flow-Session-Token) to prove the caller is the original signer; otherwise the request is rejected with 403 session_token_invalid. Once the flow has been broadcasted or source_detected, or has reached a terminal state, the request is rejected with 409 flow_invalid_transition. Each attach mints a new session token and invalidates the previous one, so at most one live token exists per flow at a time.
      * Attach a source to a flow and mint a session token
      */
     attachFlowSource(requestParameters: AttachFlowSourceRequest, initOverrides?: RequestInit): Promise<FlowSourceResponse>;

package/src/apis/SDKApi.js

@@ -422,7 +422,7 @@ import { YieldVaultRewardsResponseFromJSON } from '../models/YieldVaultRewardsRe
  */
 class SDKApi extends BaseAPI {
     /**
-     * Sets the source wallet address and chain on an initiated flow and mints the capability sessionToken used to drive the rest of the lifecycle. No API key or token is required (the browser has neither at this point) — the endpoint is gated by the flow still being initiated and by CORS. At most one live token exists per flow at a time. When re-attaching from the signing state, the existing session token must be supplied to prove the caller is the original signer.
+     * Sets the source wallet address and chain on a flow and mints the capability sessionToken used to drive the rest of the lifecycle. No API key or token is required (the browser has neither at this point) — the endpoint is gated by the flow\'s state and by CORS. A source can be attached while the flow is initiated, source_attached, quoted or signing, so a payer can switch source before broadcasting. Unlike quote, prepare, broadcast and cancel, which always require the session token, attach needs no token for the first attach or while the flow is source_attached or quoted. From signing, the current session token must be supplied (X-Dynamic-Flow-Session-Token) to prove the caller is the original signer; otherwise the request is rejected with 403 session_token_invalid. Once the flow has been broadcasted or source_detected, or has reached a terminal state, the request is rejected with 409 flow_invalid_transition. Each attach mints a new session token and invalidates the previous one, so at most one live token exists per flow at a time.
      * Attach a source to a flow and mint a session token
      */
     async attachFlowSourceRaw(requestParameters, initOverrides) {
@@ -451,7 +451,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => FlowSourceResponseFromJSON(jsonValue));
     }
     /**
-     * Sets the source wallet address and chain on an initiated flow and mints the capability sessionToken used to drive the rest of the lifecycle. No API key or token is required (the browser has neither at this point) — the endpoint is gated by the flow still being initiated and by CORS. At most one live token exists per flow at a time. When re-attaching from the signing state, the existing session token must be supplied to prove the caller is the original signer.
+     * Sets the source wallet address and chain on a flow and mints the capability sessionToken used to drive the rest of the lifecycle. No API key or token is required (the browser has neither at this point) — the endpoint is gated by the flow\'s state and by CORS. A source can be attached while the flow is initiated, source_attached, quoted or signing, so a payer can switch source before broadcasting. Unlike quote, prepare, broadcast and cancel, which always require the session token, attach needs no token for the first attach or while the flow is source_attached or quoted. From signing, the current session token must be supplied (X-Dynamic-Flow-Session-Token) to prove the caller is the original signer; otherwise the request is rejected with 403 session_token_invalid. Once the flow has been broadcasted or source_detected, or has reached a terminal state, the request is rejected with 409 flow_invalid_transition. Each attach mints a new session token and invalidates the previous one, so at most one live token exists per flow at a time.
      * Attach a source to a flow and mint a session token
      */
     async attachFlowSource(requestParameters, initOverrides) {

package/src/apis/ServerApi.d.ts

@@ -23,6 +23,10 @@ export interface BackupKeySharesToLocationsServerRequest {
     backupKeySharesToLocationsRequest: BackupKeySharesToLocationsRequest;
     xDynServerSigningProof?: string;
 }
+export interface CancelFlowServerRequest {
+    environmentId: string;
+    flowId: string;
+}
 export interface CreateBusinessAccountServerRequest {
     environmentId: string;
     xDynServerSigningProof?: string;
@@ -225,6 +229,16 @@ export declare class ServerApi extends runtime.BaseAPI {
      * Server — create backup action and event for multiple locations without performing actual backup
      */
     backupKeySharesToLocationsServer(requestParameters: BackupKeySharesToLocationsServerRequest, initOverrides?: RequestInit): Promise<BackupKeySharesToLocationsResponse>;
+    /**
+     * Cancels a flow that is still initiated, meaning no source has been attached yet. Returns 400 if flowId is not a valid UUID and 409 if the flow is in any other state. Requires an environment API token with the flow.write scope.
+     * Cancel a flow
+     */
+    cancelFlowServerRaw(requestParameters: CancelFlowServerRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Flow>>;
+    /**
+     * Cancels a flow that is still initiated, meaning no source has been attached yet. Returns 400 if flowId is not a valid UUID and 409 if the flow is in any other state. Requires an environment API token with the flow.write scope.
+     * Cancel a flow
+     */
+    cancelFlowServer(requestParameters: CancelFlowServerRequest, initOverrides?: RequestInit): Promise<Flow>;
     /**
      * Create a business account from the server SDK. The authenticated service user becomes the first `owner` member. Gated by the `enable-business-accounts` feature flag.
      * Server — create a business account
@@ -356,10 +370,12 @@ export declare class ServerApi extends runtime.BaseAPI {
      */
     getFlowFeeClaimBalancesServer(requestParameters: GetFlowFeeClaimBalancesServerRequest, initOverrides?: RequestInit): Promise<FlowFeeBalancesResponse>;
     /**
+     * Returns the flow with its full, unredacted details, including destination addresses, the settlement transaction hash, and the settlement and destination configuration. Call it as GET /server/{environmentId}/flow/{flowId}; the path segment is the flow ID. Requires an environment API token with the flow.write scope.
      * Get a flow by ID
      */
     getFlowServerRaw(requestParameters: GetFlowServerRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Flow>>;
     /**
+     * Returns the flow with its full, unredacted details, including destination addresses, the settlement transaction hash, and the settlement and destination configuration. Call it as GET /server/{environmentId}/flow/{flowId}; the path segment is the flow ID. Requires an environment API token with the flow.write scope.
      * Get a flow by ID
      */
     getFlowServer(requestParameters: GetFlowServerRequest, initOverrides?: RequestInit): Promise<Flow>;

package/src/apis/ServerApi.js

@@ -333,6 +333,35 @@ class ServerApi extends BaseAPI {
         const response = await this.backupKeySharesToLocationsServerRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Cancels a flow that is still initiated, meaning no source has been attached yet. Returns 400 if flowId is not a valid UUID and 409 if the flow is in any other state. Requires an environment API token with the flow.write scope.
+     * Cancel a flow
+     */
+    async cancelFlowServerRaw(requestParameters, initOverrides) {
+        if (requestParameters.environmentId === null || requestParameters.environmentId === undefined) {
+            throw new RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling cancelFlowServer.');
+        }
+        if (requestParameters.flowId === null || requestParameters.flowId === undefined) {
+            throw new RequiredError('flowId', 'Required parameter requestParameters.flowId was null or undefined when calling cancelFlowServer.');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        const response = await this.request({
+            path: `/server/{environmentId}/flow/{flowId}/cancel`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))).replace(`{${"flowId"}}`, encodeURIComponent(String(requestParameters.flowId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new JSONApiResponse(response, (jsonValue) => FlowFromJSON(jsonValue));
+    }
+    /**
+     * Cancels a flow that is still initiated, meaning no source has been attached yet. Returns 400 if flowId is not a valid UUID and 409 if the flow is in any other state. Requires an environment API token with the flow.write scope.
+     * Cancel a flow
+     */
+    async cancelFlowServer(requestParameters, initOverrides) {
+        const response = await this.cancelFlowServerRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Create a business account from the server SDK. The authenticated service user becomes the first `owner` member. Gated by the `enable-business-accounts` feature flag.
      * Server — create a business account
@@ -769,6 +798,7 @@ class ServerApi extends BaseAPI {
         return await response.value();
     }
     /**
+     * Returns the flow with its full, unredacted details, including destination addresses, the settlement transaction hash, and the settlement and destination configuration. Call it as GET /server/{environmentId}/flow/{flowId}; the path segment is the flow ID. Requires an environment API token with the flow.write scope.
      * Get a flow by ID
      */
     async getFlowServerRaw(requestParameters, initOverrides) {
@@ -789,6 +819,7 @@ class ServerApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => FlowFromJSON(jsonValue));
     }
     /**
+     * Returns the flow with its full, unredacted details, including destination addresses, the settlement transaction hash, and the settlement and destination configuration. Call it as GET /server/{environmentId}/flow/{flowId}; the path segment is the flow ID. Requires an environment API token with the flow.write scope.
      * Get a flow by ID
      */
     async getFlowServer(requestParameters, initOverrides) {

package/src/index.js

@@ -604,6 +604,7 @@ export { NextViewEnum, NextViewEnumFromJSON, NextViewEnumFromJSONTyped, NextView
 export { NonceResponseFromJSON, NonceResponseFromJSONTyped, NonceResponseToJSON } from './models/NonceResponse.js';
 export { NoncesResponseFromJSON, NoncesResponseFromJSONTyped, NoncesResponseToJSON } from './models/NoncesResponse.js';
 export { NotFoundFromJSON, NotFoundFromJSONTyped, NotFoundToJSON } from './models/NotFound.js';
+export { NotFoundWithoutCodeFromJSON, NotFoundWithoutCodeFromJSONTyped, NotFoundWithoutCodeToJSON } from './models/NotFoundWithoutCode.js';
 export { OAuthAccountFromJSON, OAuthAccountFromJSONTyped, OAuthAccountToJSON } from './models/OAuthAccount.js';
 export { OauthInitAuthRequestFromJSON, OauthInitAuthRequestFromJSONTyped, OauthInitAuthRequestToJSON } from './models/OauthInitAuthRequest.js';
 export { OauthProviderLoginUrlFromJSON, OauthProviderLoginUrlFromJSONTyped, OauthProviderLoginUrlToJSON } from './models/OauthProviderLoginUrl.js';

package/src/models/FlowCreateRequest.d.ts

@@ -57,7 +57,7 @@ export interface FlowCreateRequest {
      */
     feeConfig?: FlowFeeConfig;
     /**
-     * Seconds until the flow expires (default 3600, clamped server-side)
+     * Seconds until the flow expires. Default 86400 (24 hours); values above 31536000 (365 days) are clamped. Expiry applies only before the payment is broadcast.
      * @type {number}
      * @memberof FlowCreateRequest
      */

package/src/models/FlowPaymentLinkCreateRequest.d.ts

@@ -57,7 +57,7 @@ export interface FlowPaymentLinkCreateRequest {
      */
     feeConfig?: FlowFeeConfig;
     /**
-     * Seconds until the flow expires (default 3600, clamped server-side)
+     * Seconds until the flow expires. Default 86400 (24 hours); values above 31536000 (365 days) are clamped. Expiry applies only before the payment is broadcast.
      * @type {number}
      * @memberof FlowPaymentLinkCreateRequest
      */

package/src/models/FlowSourceResponse.d.ts

@@ -23,7 +23,7 @@ export interface FlowSourceResponse {
      */
     sessionExpiresAt: Date;
     /**
-     * Opaque capability token for authenticating subsequent calls on this flow (quote/prepare/broadcast). Minted by the source endpoint and returned exactly once — store it immediately. At most one live token exists per flow at a time. Format: dft_<base64url>.
+     * Opaque capability token for authenticating subsequent calls on this flow (quote, prepare, broadcast, cancel). Minted by the source endpoint and returned exactly once — store it immediately. At most one live token exists per flow at a time. Format: dft_<base64url>.
      * @type {string}
      * @memberof FlowSourceResponse
      */

package/src/models/NotFoundWithoutCode.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface NotFoundWithoutCode
+ */
+export interface NotFoundWithoutCode {
+    /**
+     * Human-readable error message
+     * @type {string}
+     * @memberof NotFoundWithoutCode
+     */
+    error: string;
+}
+export declare function NotFoundWithoutCodeFromJSON(json: any): NotFoundWithoutCode;
+export declare function NotFoundWithoutCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotFoundWithoutCode;
+export declare function NotFoundWithoutCodeToJSON(value?: NotFoundWithoutCode | null): any;

package/src/models/NotFoundWithoutCode.js

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+function NotFoundWithoutCodeFromJSON(json) {
+    return NotFoundWithoutCodeFromJSONTyped(json);
+}
+function NotFoundWithoutCodeFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': json['error'],
+    };
+}
+function NotFoundWithoutCodeToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': value.error,
+    };
+}
+
+export { NotFoundWithoutCodeFromJSON, NotFoundWithoutCodeFromJSONTyped, NotFoundWithoutCodeToJSON };

package/src/models/index.d.ts

@@ -551,6 +551,7 @@ export * from './NextViewEnum';
 export * from './NonceResponse';
 export * from './NoncesResponse';
 export * from './NotFound';
+export * from './NotFoundWithoutCode';
 export * from './OAuthAccount';
 export * from './OauthInitAuthRequest';
 export * from './OauthProviderLoginUrl';