@dfns/sdk 0.8.7 → 0.8.9

package/generated/allocations/types.d.ts

@@ -72,10 +72,11 @@ export type CreateAllocationResponse = {
         kind: "Deposit" | "Withdraw";
         /** Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+        /** The user who initiated the request. */
         requester: {
-            /** User (could be a service account) who requested the resource. */
+            /** User id. */
             userId: string;
-            /** Service Account token or Personal Access token used when requesting the resource. */
+            /** Token id. */
             tokenId?: string | undefined;
         };
         /** The full request used for initiating this allocation action. */
@@ -200,10 +201,11 @@ export type CreateAllocationActionResponse = {
         kind: "Deposit" | "Withdraw";
         /** Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+        /** The user who initiated the request. */
         requester: {
-            /** User (could be a service account) who requested the resource. */
+            /** User id. */
             userId: string;
-            /** Service Account token or Personal Access token used when requesting the resource. */
+            /** Token id. */
             tokenId?: string | undefined;
         };
         /** The full request used for initiating this allocation action. */
@@ -310,10 +312,11 @@ export type GetAllocationResponse = {
         kind: "Deposit" | "Withdraw";
         /** Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+        /** The user who initiated the request. */
         requester: {
-            /** User (could be a service account) who requested the resource. */
+            /** User id. */
             userId: string;
-            /** Service Account token or Personal Access token used when requesting the resource. */
+            /** Token id. */
             tokenId?: string | undefined;
         };
         /** The full request used for initiating this allocation action. */
@@ -383,10 +386,11 @@ export type ListAllocationActionsResponse = {
         kind: "Deposit" | "Withdraw";
         /** Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed. */
         status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
+        /** The user who initiated the request. */
         requester: {
-            /** User (could be a service account) who requested the resource. */
+            /** User id. */
             userId: string;
-            /** Service Account token or Personal Access token used when requesting the resource. */
+            /** Token id. */
             tokenId?: string | undefined;
         };
         /** The full request used for initiating this allocation action. */

package/generated/auth/types.d.ts

@@ -1096,7 +1096,7 @@ export type CreateUserBody = {
     /** Value that can be used to correlate the entity with an external system. */
     externalId?: string | undefined;
     /** If set to true, the user will have to authenticate via SSO */
-    isSSORequired?: boolean;
+    isSSORequired?: boolean | undefined;
 };
 export type CreateUserResponse = {
     username: string;
@@ -2153,8 +2153,9 @@ export type RegisterEndUserResponse = {
         signingKey: {
             /** Key id. */
             id: string;
-            /** Key scheme. */
+            /** The cryptographic scheme for the key. */
             scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
+            /** The elliptic curve for the key. */
             curve: "ed25519" | "secp256k1" | "stark";
             /** Hex-encoded value of the public key. */
             publicKey: string;

package/generated/exchanges/types.d.ts

@@ -233,8 +233,11 @@ export type CreateDepositResponse = {
     exchangeReference?: string | undefined;
     kind: "Withdrawal" | "Deposit";
     walletId: string;
+    /** The user who initiated the request. */
     requester: {
+        /** User id. */
         userId: string;
+        /** Token id. */
         tokenId?: string | undefined;
     };
     requestBody: {
@@ -723,8 +726,11 @@ export type CreateWithdrawalResponse = {
     exchangeReference?: string | undefined;
     kind: "Withdrawal" | "Deposit";
     walletId: string;
+    /** The user who initiated the request. */
     requester: {
+        /** User id. */
         userId: string;
+        /** Token id. */
         tokenId?: string | undefined;
     };
     requestBody: {
@@ -1037,6 +1043,10 @@ export type ListAssetWithdrawalNetworksResponse = (({
 } | {
     kind: "Hts";
     tokenId: string;
+} | {
+    kind: "Iou";
+    currency: string;
+    issuer: string;
 } | {
     kind: "Cip56";
     instrumentId: string;
@@ -1044,6 +1054,9 @@ export type ListAssetWithdrawalNetworksResponse = (({
 } | {
     kind: "Coin" | "LockedCoin";
     coin: string;
+} | {
+    kind: "Xls33";
+    issuanceId: string;
 } | {
     kind: "Asset";
     assetId: string;

package/generated/feeSponsors/types.d.ts

@@ -105,10 +105,13 @@ export type GetFeeSponsorResponse = {
 };
 export type GetFeeSponsorRequest = GetFeeSponsorParams;
 export type ListFeeSponsorsQuery = {
-    limit?: string | undefined;
+    /** 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 ListFeeSponsorsResponse = {
+    /** Current page items. */
     items: {
         /** Fee Sponsor id. */
         id: string;
@@ -124,6 +127,7 @@ export type ListFeeSponsorsResponse = {
         /** Defines whether EndUsers and their delegated wallets can use this Fee Sponsor. */
         allowEndUser?: boolean | undefined;
     }[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
 export type ListFeeSponsorsRequest = {

package/generated/keys/types.d.ts

@@ -1,34 +1,54 @@
 export type CreateKeyBody = {
+    /** The cryptographic scheme for the key. */
     scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
+    /** The elliptic curve for the key. */
     curve: "ed25519" | "secp256k1" | "stark";
+    /** Nickname for the key. */
     name?: string | undefined;
+    /** Whether this key can be used as a master key for HD derivation. */
     masterKey?: boolean | undefined;
+    /** Options for hierarchical deterministic key derivation. */
     deriveFrom?: {
-        /** Key id. */
+        /** The master key to derive from. */
         keyId: string;
         /** Use this to specify the derivation path of the signing key. One will be auto generated if left blank. */
         path?: string | undefined;
     } | undefined;
+    /** The key store to save the key to. */
     storeId?: string | undefined;
+    /** ID of the end user to delegate this key to. */
     delegateTo?: string | undefined;
+    /** Whether to delay delegation until explicitly triggered. */
     delayDelegation?: boolean | undefined;
 };
 export type CreateKeyResponse = {
+    /** Unique identifier for the key. */
     id: string;
+    /** The cryptographic scheme for the key. */
     scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
+    /** The elliptic curve for the key. */
     curve: "ed25519" | "secp256k1" | "stark";
+    /** Hex-encoded public key. */
     publicKey: string;
+    /** Whether this key can be used as a master key for HD derivation. */
     masterKey?: boolean | undefined;
+    /** Derivation info if this key was derived from a master key. */
     derivedFrom?: {
-        /** Key id. */
+        /** The master key this key was derived from. */
         keyId: string;
+        /** The derivation path used. */
         path: string;
     } | undefined;
+    /** Nickname for the key. */
     name?: string | undefined;
+    /** Current status of the key. */
     status: "Active" | "Archived";
+    /** Whether the key is custodial (owned by organization) or non-custodial (delegated to end user). */
     custodial: boolean;
     dateCreated: string;
+    /** Whether this key was imported. */
     imported?: boolean | undefined;
+    /** Whether this key has been exported. */
     exported?: boolean | undefined;
     dateExported?: string | undefined;
     dateDeleted?: string | undefined;
@@ -53,21 +73,33 @@ export type DeleteKeyParams = {
     keyId: string;
 };
 export type DeleteKeyResponse = {
+    /** Unique identifier for the key. */
     id: string;
+    /** The cryptographic scheme for the key. */
     scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
+    /** The elliptic curve for the key. */
     curve: "ed25519" | "secp256k1" | "stark";
+    /** Hex-encoded public key. */
     publicKey: string;
+    /** Whether this key can be used as a master key for HD derivation. */
     masterKey?: boolean | undefined;
+    /** Derivation info if this key was derived from a master key. */
     derivedFrom?: {
-        /** Key id. */
+        /** The master key this key was derived from. */
         keyId: string;
+        /** The derivation path used. */
         path: string;
     } | undefined;
+    /** Nickname for the key. */
     name?: string | undefined;
+    /** Current status of the key. */
     status: "Active" | "Archived";
+    /** Whether the key is custodial (owned by organization) or non-custodial (delegated to end user). */
     custodial: boolean;
     dateCreated: string;
+    /** Whether this key was imported. */
     imported?: boolean | undefined;
+    /** Whether this key has been exported. */
     exported?: boolean | undefined;
     dateExported?: string | undefined;
     dateDeleted?: string | undefined;
@@ -240,7 +272,7 @@ export type GenerateSignatureBody = {
 } | {
     kind: "SignerPayload";
     /** The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.
-           
+    
     Please refer to the original Polkadot definition for more details: [SignerPayloadJson](https://github.com/polkadot-js/api/blob/v16.2.2/packages/types/src/types/extrinsic.ts#L32). Note that additional fields will be rejected.
     
     | Field                | Description                                                                              | Type - Optional      |
@@ -299,13 +331,19 @@ export type GenerateSignatureBody = {
     externalId?: string | undefined;
 };
 export type GenerateSignatureParams = {
+    /** The key to sign with. */
     keyId: string;
 };
 export type GenerateSignatureResponse = {
+    /** Signature id. */
     id: string;
+    /** Key id. */
     keyId: string;
+    /** The user who initiated the request. */
     requester: {
+        /** User id. */
         userId: string;
+        /** Token id. */
         tokenId?: string | undefined;
     };
     requestBody: {
@@ -435,7 +473,7 @@ export type GenerateSignatureResponse = {
     } | {
         kind: "SignerPayload";
         /** The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.
-               
+        
         Please refer to the original Polkadot definition for more details: [SignerPayloadJson](https://github.com/polkadot-js/api/blob/v16.2.2/packages/types/src/types/extrinsic.ts#L32). Note that additional fields will be rejected.
         
         | Field                | Description                                                                              | Type - Optional      |
@@ -522,48 +560,76 @@ export type GenerateSignatureRequest = GenerateSignatureParams & {
     body: GenerateSignatureBody;
 };
 export type GetKeyParams = {
+    /** The key to retrieve. */
     keyId: string;
 };
 export type GetKeyResponse = {
+    /** Unique identifier for the key. */
     id: string;
+    /** The cryptographic scheme for the key. */
     scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
+    /** The elliptic curve for the key. */
     curve: "ed25519" | "secp256k1" | "stark";
+    /** Hex-encoded public key. */
     publicKey: string;
+    /** Whether this key can be used as a master key for HD derivation. */
     masterKey?: boolean | undefined;
+    /** Derivation info if this key was derived from a master key. */
     derivedFrom?: {
-        /** Key id. */
+        /** The master key this key was derived from. */
         keyId: string;
+        /** The derivation path used. */
         path: string;
     } | undefined;
+    /** Nickname for the key. */
     name?: string | undefined;
+    /** Current status of the key. */
     status: "Active" | "Archived";
+    /** Whether the key is custodial (owned by organization) or non-custodial (delegated to end user). */
     custodial: boolean;
     dateCreated: string;
+    /** Whether this key was imported. */
     imported?: boolean | undefined;
+    /** Whether this key has been exported. */
     exported?: boolean | undefined;
     dateExported?: string | undefined;
     dateDeleted?: string | undefined;
+    /** Wallets associated with this key. */
     wallets: {
+        /** The wallet id. */
         id: string;
+        /** The network of the wallet. */
         network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Concordium" | "ConcordiumTestnet" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "TempoAndantino" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
     }[];
+    /** Key store details. */
     store: {
+        /** The key store id. */
         id: string;
+        /** The type of key store. */
         kind: "Hsm" | "Mpc";
+        /** The key id within the store. */
         keyId: string;
+        /** The HD derivation path if applicable. */
         derivationPath?: string | undefined;
     };
 };
 export type GetKeyRequest = GetKeyParams;
 export type GetSignatureParams = {
+    /** The key that was used for signing. */
     keyId: string;
+    /** The signature request to retrieve. */
     signatureId: string;
 };
 export type GetSignatureResponse = {
+    /** Signature id. */
     id: string;
+    /** Key id. */
     keyId: string;
+    /** The user who initiated the request. */
     requester: {
+        /** User id. */
         userId: string;
+        /** Token id. */
         tokenId?: string | undefined;
     };
     requestBody: {
@@ -693,7 +759,7 @@ export type GetSignatureResponse = {
     } | {
         kind: "SignerPayload";
         /** The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.
-               
+        
         Please refer to the original Polkadot definition for more details: [SignerPayloadJson](https://github.com/polkadot-js/api/blob/v16.2.2/packages/types/src/types/extrinsic.ts#L32). Note that additional fields will be rejected.
         
         | Field                | Description                                                                              | Type - Optional      |
@@ -790,21 +856,33 @@ export type ImportKeyBody = {
     masterKey?: boolean | undefined;
 };
 export type ImportKeyResponse = {
+    /** Unique identifier for the key. */
     id: string;
+    /** The cryptographic scheme for the key. */
     scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
+    /** The elliptic curve for the key. */
     curve: "ed25519" | "secp256k1" | "stark";
+    /** Hex-encoded public key. */
     publicKey: string;
+    /** Whether this key can be used as a master key for HD derivation. */
     masterKey?: boolean | undefined;
+    /** Derivation info if this key was derived from a master key. */
     derivedFrom?: {
-        /** Key id. */
+        /** The master key this key was derived from. */
         keyId: string;
+        /** The derivation path used. */
         path: string;
     } | undefined;
+    /** Nickname for the key. */
     name?: string | undefined;
+    /** Current status of the key. */
     status: "Active" | "Archived";
+    /** Whether the key is custodial (owned by organization) or non-custodial (delegated to end user). */
     custodial: boolean;
     dateCreated: string;
+    /** Whether this key was imported. */
     imported?: boolean | undefined;
+    /** Whether this key has been exported. */
     exported?: boolean | undefined;
     dateExported?: string | undefined;
     dateDeleted?: string | undefined;
@@ -813,50 +891,75 @@ export type ImportKeyRequest = {
     body: ImportKeyBody;
 };
 export type ListKeysQuery = {
-    limit?: string | undefined;
+    /** 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;
+    /** Filter by owner id or username. */
     owner?: string | undefined;
 };
 export type ListKeysResponse = {
+    /** Current page items. */
     items: {
+        /** Unique identifier for the key. */
         id: string;
+        /** The cryptographic scheme for the key. */
         scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
+        /** The elliptic curve for the key. */
         curve: "ed25519" | "secp256k1" | "stark";
+        /** Hex-encoded public key. */
         publicKey: string;
+        /** Whether this key can be used as a master key for HD derivation. */
         masterKey?: boolean | undefined;
+        /** Derivation info if this key was derived from a master key. */
         derivedFrom?: {
-            /** Key id. */
+            /** The master key this key was derived from. */
             keyId: string;
+            /** The derivation path used. */
             path: string;
         } | undefined;
+        /** Nickname for the key. */
         name?: string | undefined;
+        /** Current status of the key. */
         status: "Active" | "Archived";
+        /** Whether the key is custodial (owned by organization) or non-custodial (delegated to end user). */
         custodial: boolean;
         dateCreated: string;
+        /** Whether this key was imported. */
         imported?: boolean | undefined;
+        /** Whether this key has been exported. */
         exported?: boolean | undefined;
         dateExported?: string | undefined;
         dateDeleted?: string | undefined;
     }[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
 export type ListKeysRequest = {
     query?: ListKeysQuery;
 };
 export type ListSignaturesParams = {
+    /** The key to list signatures for. */
     keyId: string;
 };
 export type ListSignaturesQuery = {
-    limit?: string | undefined;
+    /** 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 ListSignaturesResponse = {
-    keyId: string;
+    /** Current page items. */
     items: {
+        /** Signature id. */
         id: string;
+        /** Key id. */
         keyId: string;
+        /** The user who initiated the request. */
         requester: {
+            /** User id. */
             userId: string;
+            /** Token id. */
             tokenId?: string | undefined;
         };
         requestBody: {
@@ -986,7 +1089,7 @@ export type ListSignaturesResponse = {
         } | {
             kind: "SignerPayload";
             /** The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.
-                   
+            
             Please refer to the original Polkadot definition for more details: [SignerPayloadJson](https://github.com/polkadot-js/api/blob/v16.2.2/packages/types/src/types/extrinsic.ts#L32). Note that additional fields will be rejected.
             
             | Field                | Description                                                                              | Type - Optional      |
@@ -1069,7 +1172,10 @@ export type ListSignaturesResponse = {
         dateConfirmed?: string | undefined;
         externalId?: string | undefined;
     }[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
+    /** The key these signatures belong to. */
+    keyId: string;
 };
 export type ListSignaturesRequest = ListSignaturesParams & {
     query?: ListSignaturesQuery;
@@ -1081,21 +1187,33 @@ export type UpdateKeyParams = {
     keyId: string;
 };
 export type UpdateKeyResponse = {
+    /** Unique identifier for the key. */
     id: string;
+    /** The cryptographic scheme for the key. */
     scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
+    /** The elliptic curve for the key. */
     curve: "ed25519" | "secp256k1" | "stark";
+    /** Hex-encoded public key. */
     publicKey: string;
+    /** Whether this key can be used as a master key for HD derivation. */
     masterKey?: boolean | undefined;
+    /** Derivation info if this key was derived from a master key. */
     derivedFrom?: {
-        /** Key id. */
+        /** The master key this key was derived from. */
         keyId: string;
+        /** The derivation path used. */
         path: string;
     } | undefined;
+    /** Nickname for the key. */
     name?: string | undefined;
+    /** Current status of the key. */
     status: "Active" | "Archived";
+    /** Whether the key is custodial (owned by organization) or non-custodial (delegated to end user). */
     custodial: boolean;
     dateCreated: string;
+    /** Whether this key was imported. */
     imported?: boolean | undefined;
+    /** Whether this key has been exported. */
     exported?: boolean | undefined;
     dateExported?: string | undefined;
     dateDeleted?: string | undefined;

package/generated/networks/types.d.ts

@@ -124,7 +124,7 @@ export type GetFeesQuery = {
 };
 export type GetFeesResponse = {
     kind: "Bitcoin";
-    network: ("Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3") | ("Dogecoin" | "DogecoinTestnet") | ("Litecoin" | "LitecoinTestnet");
+    network: "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "Litecoin" | "LitecoinTestnet" | "DogecoinTestnet" | "Dogecoin";
     blockNumber: number;
     slow: {
         feeRate: string;

package/generated/permissions/types.d.ts

@@ -56,7 +56,7 @@ export type DeleteAssignmentParams = {
     assignmentId: string;
 };
 export type DeleteAssignmentQuery = {
-    force?: boolean;
+    force?: boolean | undefined;
 };
 export type DeleteAssignmentResponse = void | undefined;
 export type DeleteAssignmentRequest = DeleteAssignmentParams & {
@@ -77,6 +77,7 @@ export type GetPermissionResponse = {
 } & {
     pendingChangeRequest?: {
         id: string;
+        /** The user who initiated the change request. */
         requester: {
             userId: string;
             tokenId?: string | undefined;
@@ -114,6 +115,7 @@ export type ListAssignmentsResponse = {
     } & {
         pendingChangeRequest?: {
             id: string;
+            /** The user who initiated the change request. */
             requester: {
                 userId: string;
                 tokenId?: string | undefined;
@@ -154,6 +156,7 @@ export type ListPermissionsResponse = {
     } & {
         pendingChangeRequest?: {
             id: string;
+            /** The user who initiated the change request. */
             requester: {
                 userId: string;
                 tokenId?: string | undefined;