@dfns/sdk 0.7.14-rc.0 → 0.7.15-rc.0

package/generated/swaps/types.d.ts

@@ -1,10 +1,17 @@
 export type CreateSwapBody = {
+    /** Quote to use for this swap. */
     quoteId: string;
+    /** An optional reference for this Swap. */
     reference?: string | undefined;
+    /** Provided for this swap. Used for attesting that the swap is being created with the same parameters as the quote. */
     provider: "UniswapX" | "UniswapClassic";
+    /** Id of the Dfns wallet spending the sourceAsset. Used for attesting that the swap is being created with the same parameters as the quote. */
     walletId: string;
+    /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. Used for attesting that the swap is being created with the same parameters as the quote. */
     targetWalletId?: string | undefined;
+    /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. Used for attesting that the swap is being created with the same parameters as the quote.  */
     slippageBps: number;
+    /** The source asset that will be spent on the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
     sourceAsset: {
         kind: "Native";
         amount: string;
@@ -13,6 +20,7 @@ export type CreateSwapBody = {
         contract: string;
         amount: string;
     };
+    /** The target asset that will be received with the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
     targetAsset: {
         kind: "Native";
         amount: string;
@@ -23,13 +31,21 @@ export type CreateSwapBody = {
     };
 };
 export type CreateSwapResponse = {
+    /** Swap id. */
     id: string;
+    /** Id of the quote this swap is based on. */
     quoteId: string;
+    /** Optional user-defined reference for this Swap. */
     reference: string | null;
+    /** Id of the Dfns wallet spending the sourceAsset. */
     walletId: string;
+    /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
     targetWalletId: string;
+    /** Swap status. */
     status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+    /** Swap provider. */
     provider: "UniswapX" | "UniswapClassic";
+    /** The source asset for this swap transaction. */
     quotedSourceAsset: ({
         kind: "Native";
         amount: string;
@@ -46,6 +62,7 @@ export type CreateSwapResponse = {
             tid?: string | undefined;
         };
     };
+    /** The target asset for this swap transaction. */
     quotedTargetAsset: ({
         kind: "Native";
         amount: string;
@@ -62,15 +79,25 @@ export type CreateSwapResponse = {
             tid?: string | undefined;
         };
     };
+    /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
     slippageBps: number;
+    /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the swap was initiated. */
     dateCreated: string;
+    /** The full request used for initiating this swap. */
     requestBody: {
+        /** Quote to use for this swap. */
         quoteId: string;
+        /** An optional reference for this Swap. */
         reference?: string | undefined;
+        /** Provided for this swap. Used for attesting that the swap is being created with the same parameters as the quote. */
         provider: "UniswapX" | "UniswapClassic";
+        /** Id of the Dfns wallet spending the sourceAsset. Used for attesting that the swap is being created with the same parameters as the quote. */
         walletId: string;
+        /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. Used for attesting that the swap is being created with the same parameters as the quote. */
         targetWalletId?: string | undefined;
+        /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. Used for attesting that the swap is being created with the same parameters as the quote.  */
         slippageBps: number;
+        /** The source asset that will be spent on the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
         sourceAsset: {
             kind: "Native";
             amount: string;
@@ -79,6 +106,7 @@ export type CreateSwapResponse = {
             contract: string;
             amount: string;
         };
+        /** The target asset that will be received with the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
         targetAsset: {
             kind: "Native";
             amount: string;
@@ -89,7 +117,9 @@ export type CreateSwapResponse = {
         };
     } | {};
     requester: {
+        /** User (could be a service account) who requested the resource. */
         userId: string;
+        /** Service Account token or Personal Access token used when requesting the resource. */
         tokenId?: string | undefined;
     };
 };
@@ -97,9 +127,13 @@ export type CreateSwapRequest = {
     body: CreateSwapBody;
 };
 export type CreateSwapQuoteBody = {
+    /** Swap provider. */
     provider: "UniswapX" | "UniswapClassic";
+    /** Id of the Dfns wallet spending the sourceAsset. */
     walletId: string;
+    /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
     targetWalletId?: string | undefined;
+    /** The source asset that will be spent on the Swap transaction, following the same stucture as the [transfer API](https://docs.dfns.co/api-reference/wallets/transfer-asset). */
     sourceAsset: {
         kind: "Native";
         amount: string;
@@ -108,20 +142,26 @@ export type CreateSwapQuoteBody = {
         contract: string;
         amount: string;
     };
+    /** The target asset that will be received with the Swap transaction, follows the same structure as sourceAsset, but doesn't include the amount. */
     targetAsset: {
         kind: "Native";
     } | {
         kind: "Erc20";
         contract: string;
     };
+    /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you're willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
     slippageBps: number;
 };
 export type CreateSwapQuoteResponse = {
+    /** ID of the Swap Quote. */
     id: string;
+    /** Id of the Dfns wallet spending the sourceAsset. */
     walletId: string;
     /** If not provided, the walletId is used as the target wallet. If provided, this field is currently required to be the same as walletId */
     targetWalletId?: string | undefined;
+    /** Swap provider. */
     provider: "UniswapX" | "UniswapClassic";
+    /** The source asset that will be spent on the swap transaction. */
     sourceAsset: ({
         kind: "Native";
         amount: string;
@@ -138,6 +178,7 @@ export type CreateSwapQuoteResponse = {
             tid?: string | undefined;
         };
     };
+    /** The target asset that will be received with the swap transaction. */
     targetAsset: ({
         kind: "Native";
         amount: string;
@@ -154,12 +195,19 @@ export type CreateSwapQuoteResponse = {
             tid?: string | undefined;
         };
     };
+    /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you're willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
     slippageBps: number;
+    /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the quote was created. */
     dateCreated: string;
+    /** The full request used for obtaining this quote. */
     requestBody: {
+        /** Swap provider. */
         provider: "UniswapX" | "UniswapClassic";
+        /** Id of the Dfns wallet spending the sourceAsset. */
         walletId: string;
+        /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
         targetWalletId?: string | undefined;
+        /** The source asset that will be spent on the Swap transaction, following the same stucture as the [transfer API](https://docs.dfns.co/api-reference/wallets/transfer-asset). */
         sourceAsset: {
             kind: "Native";
             amount: string;
@@ -168,16 +216,20 @@ export type CreateSwapQuoteResponse = {
             contract: string;
             amount: string;
         };
+        /** The target asset that will be received with the Swap transaction, follows the same structure as sourceAsset, but doesn't include the amount. */
         targetAsset: {
             kind: "Native";
         } | {
             kind: "Erc20";
             contract: string;
         };
+        /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you're willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
         slippageBps: number;
     } | {};
     requester: {
+        /** User (could be a service account) who requested the quote. */
         userId: string;
+        /** Service Account token or Personal Access token used when requesting the quote. */
         tokenId?: string | undefined;
     };
 };
@@ -185,16 +237,25 @@ export type CreateSwapQuoteRequest = {
     body: CreateSwapQuoteBody;
 };
 export type GetSwapParams = {
+    /** Id of the swap for which we want to get details. */
     swapId: string;
 };
 export type GetSwapResponse = {
+    /** Swap id. */
     id: string;
+    /** Id of the quote this swap is based on. */
     quoteId: string;
+    /** Optional user-defined reference for this Swap. */
     reference: string | null;
+    /** Id of the Dfns wallet spending the sourceAsset. */
     walletId: string;
+    /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
     targetWalletId: string;
+    /** Swap status. */
     status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+    /** Swap provider. */
     provider: "UniswapX" | "UniswapClassic";
+    /** The source asset for this swap transaction. */
     quotedSourceAsset: ({
         kind: "Native";
         amount: string;
@@ -211,6 +272,7 @@ export type GetSwapResponse = {
             tid?: string | undefined;
         };
     };
+    /** The target asset for this swap transaction. */
     quotedTargetAsset: ({
         kind: "Native";
         amount: string;
@@ -227,15 +289,25 @@ export type GetSwapResponse = {
             tid?: string | undefined;
         };
     };
+    /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
     slippageBps: number;
+    /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the swap was initiated. */
     dateCreated: string;
+    /** The full request used for initiating this swap. */
     requestBody: {
+        /** Quote to use for this swap. */
         quoteId: string;
+        /** An optional reference for this Swap. */
         reference?: string | undefined;
+        /** Provided for this swap. Used for attesting that the swap is being created with the same parameters as the quote. */
         provider: "UniswapX" | "UniswapClassic";
+        /** Id of the Dfns wallet spending the sourceAsset. Used for attesting that the swap is being created with the same parameters as the quote. */
         walletId: string;
+        /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. Used for attesting that the swap is being created with the same parameters as the quote. */
         targetWalletId?: string | undefined;
+        /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. Used for attesting that the swap is being created with the same parameters as the quote.  */
         slippageBps: number;
+        /** The source asset that will be spent on the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
         sourceAsset: {
             kind: "Native";
             amount: string;
@@ -244,6 +316,7 @@ export type GetSwapResponse = {
             contract: string;
             amount: string;
         };
+        /** The target asset that will be received with the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
         targetAsset: {
             kind: "Native";
             amount: string;
@@ -254,20 +327,27 @@ export type GetSwapResponse = {
         };
     } | {};
     requester: {
+        /** User (could be a service account) who requested the resource. */
         userId: string;
+        /** Service Account token or Personal Access token used when requesting the resource. */
         tokenId?: string | undefined;
     };
 };
 export type GetSwapRequest = GetSwapParams;
 export type GetSwapQuoteParams = {
+    /** The ID of the Swap Quote. */
     quoteId: string;
 };
 export type GetSwapQuoteResponse = {
+    /** ID of the Swap Quote. */
     id: string;
+    /** Id of the Dfns wallet spending the sourceAsset. */
     walletId: string;
     /** If not provided, the walletId is used as the target wallet. If provided, this field is currently required to be the same as walletId */
     targetWalletId?: string | undefined;
+    /** Swap provider. */
     provider: "UniswapX" | "UniswapClassic";
+    /** The source asset that will be spent on the swap transaction. */
     sourceAsset: ({
         kind: "Native";
         amount: string;
@@ -284,6 +364,7 @@ export type GetSwapQuoteResponse = {
             tid?: string | undefined;
         };
     };
+    /** The target asset that will be received with the swap transaction. */
     targetAsset: ({
         kind: "Native";
         amount: string;
@@ -300,12 +381,19 @@ export type GetSwapQuoteResponse = {
             tid?: string | undefined;
         };
     };
+    /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you're willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
     slippageBps: number;
+    /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the quote was created. */
     dateCreated: string;
+    /** The full request used for obtaining this quote. */
     requestBody: {
+        /** Swap provider. */
         provider: "UniswapX" | "UniswapClassic";
+        /** Id of the Dfns wallet spending the sourceAsset. */
         walletId: string;
+        /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
         targetWalletId?: string | undefined;
+        /** The source asset that will be spent on the Swap transaction, following the same stucture as the [transfer API](https://docs.dfns.co/api-reference/wallets/transfer-asset). */
         sourceAsset: {
             kind: "Native";
             amount: string;
@@ -314,33 +402,48 @@ export type GetSwapQuoteResponse = {
             contract: string;
             amount: string;
         };
+        /** The target asset that will be received with the Swap transaction, follows the same structure as sourceAsset, but doesn't include the amount. */
         targetAsset: {
             kind: "Native";
         } | {
             kind: "Erc20";
             contract: string;
         };
+        /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you're willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
         slippageBps: number;
     } | {};
     requester: {
+        /** User (could be a service account) who requested the quote. */
         userId: string;
+        /** Service Account token or Personal Access token used when requesting the quote. */
         tokenId?: string | undefined;
     };
 };
 export type GetSwapQuoteRequest = GetSwapQuoteParams;
 export type ListSwapsQuery = {
+    /** Maximum number of items to return. */
     limit?: number | undefined;
+    /** Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. */
     paginationToken?: string | undefined;
 };
 export type ListSwapsResponse = {
+    /** Current page items. */
     items: {
+        /** Swap id. */
         id: string;
+        /** Id of the quote this swap is based on. */
         quoteId: string;
+        /** Optional user-defined reference for this Swap. */
         reference: string | null;
+        /** Id of the Dfns wallet spending the sourceAsset. */
         walletId: string;
+        /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. */
         targetWalletId: string;
+        /** Swap status. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+        /** Swap provider. */
         provider: "UniswapX" | "UniswapClassic";
+        /** The source asset for this swap transaction. */
         quotedSourceAsset: ({
             kind: "Native";
             amount: string;
@@ -357,6 +460,7 @@ export type ListSwapsResponse = {
                 tid?: string | undefined;
             };
         };
+        /** The target asset for this swap transaction. */
         quotedTargetAsset: ({
             kind: "Native";
             amount: string;
@@ -373,15 +477,25 @@ export type ListSwapsResponse = {
                 tid?: string | undefined;
             };
         };
+        /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. */
         slippageBps: number;
+        /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the swap was initiated. */
         dateCreated: string;
+        /** The full request used for initiating this swap. */
         requestBody: {
+            /** Quote to use for this swap. */
             quoteId: string;
+            /** An optional reference for this Swap. */
             reference?: string | undefined;
+            /** Provided for this swap. Used for attesting that the swap is being created with the same parameters as the quote. */
             provider: "UniswapX" | "UniswapClassic";
+            /** Id of the Dfns wallet spending the sourceAsset. Used for attesting that the swap is being created with the same parameters as the quote. */
             walletId: string;
+            /** Id of the Dfns wallet receiving the target asset. Currently this value must be the same as the `walletId`. Used for attesting that the swap is being created with the same parameters as the quote. */
             targetWalletId?: string | undefined;
+            /** The slippage tolerance for this trade in [basis point](https://en.wikipedia.org/wiki/Basis_point) (BPS). Slippage tolerance defines the maximum price difference you are willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%. Used for attesting that the swap is being created with the same parameters as the quote.  */
             slippageBps: number;
+            /** The source asset that will be spent on the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
             sourceAsset: {
                 kind: "Native";
                 amount: string;
@@ -390,6 +504,7 @@ export type ListSwapsResponse = {
                 contract: string;
                 amount: string;
             };
+            /** The target asset that will be received with the Swap transaction. Used for attesting that the swap is being created with the same parameters as the quote. */
             targetAsset: {
                 kind: "Native";
                 amount: string;
@@ -400,10 +515,13 @@ export type ListSwapsResponse = {
             };
         } | {};
         requester: {
+            /** User (could be a service account) who requested the resource. */
             userId: string;
+            /** Service Account token or Personal Access token used when requesting the resource. */
             tokenId?: string | undefined;
         };
     }[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
 export type ListSwapsRequest = {