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

package/generated/auth/client.d.ts

@@ -69,8 +69,8 @@ export declare class AuthClient {
     sendLoginCode(request: T.SendLoginCodeRequest): Promise<T.SendLoginCodeResponse>;
     sendRecoveryCode(request: T.SendRecoveryCodeRequest): Promise<T.SendRecoveryCodeResponse>;
     socialLogin(request: T.SocialLoginRequest): Promise<T.SocialLoginResponse>;
-    sSOLogin(request: T.SSOLoginRequest): Promise<T.SSOLoginResponse>;
-    sSOLoginInit(request: T.SSOLoginInitRequest): Promise<T.SSOLoginInitResponse>;
+    ssoLogin(request: T.SsoLoginRequest): Promise<T.SsoLoginResponse>;
+    ssoLoginInit(request: T.SsoLoginInitRequest): Promise<T.SsoLoginInitResponse>;
     updatePersonalAccessToken(request: T.UpdatePersonalAccessTokenRequest): Promise<T.UpdatePersonalAccessTokenResponse>;
     updateServiceAccount(request: T.UpdateServiceAccountRequest): Promise<T.UpdateServiceAccountResponse>;
     updateUser(request: T.UpdateUserRequest): Promise<T.UpdateUserResponse>;

package/generated/auth/client.js

@@ -610,7 +610,7 @@ class AuthClient {
         });
         return response.json();
     }
-    async sSOLogin(request) {
+    async ssoLogin(request) {
         const path = (0, url_1.buildPathAndQuery)('/auth/login/sso', {
             path: request ?? {},
             query: {},
@@ -622,7 +622,7 @@ class AuthClient {
         });
         return response.json();
     }
-    async sSOLoginInit(request) {
+    async ssoLoginInit(request) {
         const path = (0, url_1.buildPathAndQuery)('/auth/login/sso/init', {
             path: request ?? {},
             query: {},

package/generated/auth/delegatedClient.d.ts

@@ -81,8 +81,8 @@ export declare class DelegatedAuthClient {
     sendLoginCode(request: T.SendLoginCodeRequest): Promise<T.SendLoginCodeResponse>;
     sendRecoveryCode(request: T.SendRecoveryCodeRequest): Promise<T.SendRecoveryCodeResponse>;
     socialLogin(request: T.SocialLoginRequest): Promise<T.SocialLoginResponse>;
-    sSOLogin(request: T.SSOLoginRequest): Promise<T.SSOLoginResponse>;
-    sSOLoginInit(request: T.SSOLoginInitRequest): Promise<T.SSOLoginInitResponse>;
+    ssoLogin(request: T.SsoLoginRequest): Promise<T.SsoLoginResponse>;
+    ssoLoginInit(request: T.SsoLoginInitRequest): Promise<T.SsoLoginInitResponse>;
     updatePersonalAccessTokenInit(request: T.UpdatePersonalAccessTokenRequest): Promise<UserActionChallengeResponse>;
     updatePersonalAccessTokenComplete(request: T.UpdatePersonalAccessTokenRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.UpdatePersonalAccessTokenResponse>;
     updateServiceAccountInit(request: T.UpdateServiceAccountRequest): Promise<UserActionChallengeResponse>;

package/generated/auth/delegatedClient.js

@@ -878,7 +878,7 @@ class DelegatedAuthClient {
         });
         return response.json();
     }
-    async sSOLogin(request) {
+    async ssoLogin(request) {
         const path = (0, url_1.buildPathAndQuery)('/auth/login/sso', {
             path: request ?? {},
             query: {},
@@ -890,7 +890,7 @@ class DelegatedAuthClient {
         });
         return response.json();
     }
-    async sSOLoginInit(request) {
+    async ssoLoginInit(request) {
         const path = (0, url_1.buildPathAndQuery)('/auth/login/sso/init', {
             path: request ?? {},
             query: {},

package/generated/auth/types.d.ts

@@ -15,7 +15,7 @@ export type ActivatePersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
-    /** Access token kind */
+    /** Access token kind. */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -38,7 +38,9 @@ export type ActivateServiceAccountResponse = {
     userInfo: {
         username: string;
         name: string;
+        /** User id. */
         userId: string;
+        /** User kind. */
         kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
         credentialUuid: string;
         orgId: string;
@@ -58,7 +60,7 @@ export type ActivateServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
-        /** Access token kind */
+        /** Access token kind. */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -81,7 +83,9 @@ export type ActivateUserParams = {
 export type ActivateUserResponse = {
     username: string;
     name: string;
+    /** User id. */
     userId: string;
+    /** User kind. */
     kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
     credentialUuid: string;
     orgId: string;
@@ -106,7 +110,7 @@ export type ArchivePersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
-    /** Access token kind */
+    /** Access token kind. */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -129,7 +133,9 @@ export type ArchiveServiceAccountResponse = {
     userInfo: {
         username: string;
         name: string;
+        /** User id. */
         userId: string;
+        /** User kind. */
         kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
         credentialUuid: string;
         orgId: string;
@@ -149,7 +155,7 @@ export type ArchiveServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
-        /** Access token kind */
+        /** Access token kind. */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -172,7 +178,9 @@ export type ArchiveUserParams = {
 export type ArchiveUserResponse = {
     username: string;
     name: string;
+    /** User id. */
     userId: string;
+    /** User kind. */
     kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
     credentialUuid: string;
     orgId: string;
@@ -839,7 +847,9 @@ export type CreateServiceAccountResponse = {
     userInfo: {
         username: string;
         name: string;
+        /** User id. */
         userId: string;
+        /** User kind. */
         kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
         credentialUuid: string;
         orgId: string;
@@ -859,7 +869,7 @@ export type CreateServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
-        /** Access token kind */
+        /** Access token kind. */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -934,7 +944,9 @@ export type CreateUserBody = {
 export type CreateUserResponse = {
     username: string;
     name: string;
+    /** User id. */
     userId: string;
+    /** User kind. */
     kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
     credentialUuid: string;
     orgId: string;
@@ -1082,7 +1094,7 @@ export type DeactivatePersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
-    /** Access token kind */
+    /** Access token kind. */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -1105,7 +1117,9 @@ export type DeactivateServiceAccountResponse = {
     userInfo: {
         username: string;
         name: string;
+        /** User id. */
         userId: string;
+        /** User kind. */
         kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
         credentialUuid: string;
         orgId: string;
@@ -1125,7 +1139,7 @@ export type DeactivateServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
-        /** Access token kind */
+        /** Access token kind. */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -1148,7 +1162,9 @@ export type DeactivateUserParams = {
 export type DeactivateUserResponse = {
     username: string;
     name: string;
+    /** User id. */
     userId: string;
+    /** User kind. */
     kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
     credentialUuid: string;
     orgId: string;
@@ -1196,7 +1212,7 @@ export type GetApplicationResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
-        /** Access token kind */
+        /** Access token kind. */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -1243,7 +1259,7 @@ export type GetPersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
-    /** Access token kind */
+    /** Access token kind. */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -1266,7 +1282,9 @@ export type GetServiceAccountResponse = {
     userInfo: {
         username: string;
         name: string;
+        /** User id. */
         userId: string;
+        /** User kind. */
         kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
         credentialUuid: string;
         orgId: string;
@@ -1286,7 +1304,7 @@ export type GetServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
-        /** Access token kind */
+        /** Access token kind. */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -1309,7 +1327,9 @@ export type GetUserParams = {
 export type GetUserResponse = {
     username: string;
     name: string;
+    /** User id. */
     userId: string;
+    /** User kind. */
     kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
     credentialUuid: string;
     orgId: string;
@@ -1346,7 +1366,7 @@ export type ListApplicationsResponse = {
             dateCreated: string;
             credId: string;
             isActive: boolean;
-            /** Access token kind */
+            /** Access token kind. */
             kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
             linkedUserId: string;
             linkedAppId: string;
@@ -1391,7 +1411,7 @@ export type ListPersonalAccessTokensResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
-        /** Access token kind */
+        /** Access token kind. */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -1412,7 +1432,9 @@ export type ListServiceAccountsResponse = {
         userInfo: {
             username: string;
             name: string;
+            /** User id. */
             userId: string;
+            /** User kind. */
             kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
             credentialUuid: string;
             orgId: string;
@@ -1432,7 +1454,7 @@ export type ListServiceAccountsResponse = {
             dateCreated: string;
             credId: string;
             isActive: boolean;
-            /** Access token kind */
+            /** Access token kind. */
             kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
             linkedUserId: string;
             linkedAppId: string;
@@ -1458,7 +1480,9 @@ export type ListUsersResponse = {
     items: {
         username: string;
         name: string;
+        /** User id. */
         userId: string;
+        /** User kind. */
         kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
         credentialUuid: string;
         orgId: string;
@@ -1835,6 +1859,7 @@ export type RegisterEndUserBody = {
     } | undefined;
     wallets: {
         network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
+        /** Wallet nickname. */
         name?: string | undefined;
     }[];
 };
@@ -1861,6 +1886,7 @@ export type RegisterEndUserResponse = {
         address?: string | undefined;
         /** Details about the key underlying the wallet. */
         signingKey: {
+            /** Key id. */
             id: string;
             /** Key scheme. */
             scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
@@ -1874,6 +1900,8 @@ export type RegisterEndUserResponse = {
         status: "Active" | "Archived";
         /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
         dateCreated: string;
+        /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was deleted. */
+        dateDeleted?: string | undefined;
         /** Wallet nickname. */
         name?: string | undefined;
         /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
@@ -1930,31 +1958,32 @@ export type SocialLoginResponse = {
 export type SocialLoginRequest = {
     body: SocialLoginBody;
 };
-export type SSOLoginBody = {
+export type SsoLoginBody = {
     /** Authorization code obtained from the IdP */
     code: string;
     /** State forwarded by the IdP */
     state: string;
 };
-export type SSOLoginResponse = {
+export type SsoLoginResponse = {
     token: string;
 };
-export type SSOLoginRequest = {
-    body: SSOLoginBody;
+export type SsoLoginRequest = {
+    body: SsoLoginBody;
 };
-export type SSOLoginInitBody = {
+export type SsoLoginInitBody = {
+    /** Organization id. */
     orgId: string;
     /** Client Id obtained from the IdP */
     clientId: string;
     /** Redirect URI used for the authentication flow */
     redirectUri: string;
 };
-export type SSOLoginInitResponse = {
+export type SsoLoginInitResponse = {
     /** The URL to redirect the user to authenticate with the IdP */
     ssoRedirectUrl: string;
 };
-export type SSOLoginInitRequest = {
-    body: SSOLoginInitBody;
+export type SsoLoginInitRequest = {
+    body: SsoLoginInitBody;
 };
 export type UpdatePersonalAccessTokenBody = {
     name?: string | undefined;
@@ -1968,7 +1997,7 @@ export type UpdatePersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
-    /** Access token kind */
+    /** Access token kind. */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -1997,7 +2026,9 @@ export type UpdateServiceAccountResponse = {
     userInfo: {
         username: string;
         name: string;
+        /** User id. */
         userId: string;
+        /** User kind. */
         kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
         credentialUuid: string;
         orgId: string;
@@ -2017,7 +2048,7 @@ export type UpdateServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
-        /** Access token kind */
+        /** Access token kind. */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -2045,7 +2076,9 @@ export type UpdateUserParams = {
 export type UpdateUserResponse = {
     username: string;
     name: string;
+    /** User id. */
     userId: string;
+    /** User kind. */
     kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
     credentialUuid: string;
     orgId: string;

package/generated/exchanges/types.d.ts

@@ -983,14 +983,18 @@ export type ListAccountAssetsParams = {
     accountId: string;
 };
 export type ListAccountAssetsQuery = {
+    /** 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 ListAccountAssetsResponse = {
+    /** Current page items. */
     items: {
         symbol: string;
         balance: string;
     }[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
 export type ListAccountAssetsRequest = ListAccountAssetsParams & {
@@ -1000,16 +1004,20 @@ export type ListAccountsParams = {
     exchangeId: string;
 };
 export type ListAccountsQuery = {
+    /** 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 ListAccountsResponse = {
+    /** Current page items. */
     items: {
         id: string;
         name?: string | undefined;
         exchangeId: string;
         exchangeName?: string | undefined;
     }[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
 export type ListAccountsRequest = ListAccountsParams & {
@@ -1059,16 +1067,20 @@ export type ListAssetWithdrawalNetworksResponse = (({
 })[];
 export type ListAssetWithdrawalNetworksRequest = ListAssetWithdrawalNetworksParams;
 export type ListExchangesQuery = {
+    /** 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 ListExchangesResponse = {
+    /** Current page items. */
     items: {
         id: string;
         name?: string | undefined;
         kind: "Binance" | "Kraken" | "CoinbaseApp" | "CoinbasePrime";
         dateCreated: string;
     }[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
 export type ListExchangesRequest = {

package/generated/feeSponsors/types.d.ts

@@ -1,69 +1,106 @@
 export type ActivateFeeSponsorParams = {
+    /** Which Fee Sponsor you wish to activate. */
     feeSponsorId: string;
 };
 export type ActivateFeeSponsorResponse = {
+    /** Fee Sponsor id. */
     id: string;
+    /** Nickname for the Fee Sponsor. This is displayed on the transfer modal in the dashboard. */
     name?: string | undefined;
+    /** Id of the wallet that is used to sponsor the fee for other wallets */
     walletId: string;
+    /** Network used for the wallet. */
     network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
+    /** Fee sponsor status. */
     status: "Active" | "Deactivated" | "Archived";
     dateCreated: string;
+    /** Defines whether EndUsers and their delegated wallets can use this Fee Sponsor. */
     allowEndUser?: boolean | undefined;
 };
 export type ActivateFeeSponsorRequest = ActivateFeeSponsorParams;
 export type CreateFeeSponsorBody = {
+    /** Nickname for the Fee Sponsor. This will be displayed on the transfer modal in the dashboard. */
     name?: string | undefined;
+    /** Id of the wallet that will be used to sponsor the fee for other wallets. */
     walletId: string;
-    allowEndUser?: boolean;
+    /** Defines whether EndUsers and their delegated wallets can use this Fee Sponsor. */
+    allowEndUser?: boolean | undefined;
 };
 export type CreateFeeSponsorResponse = {
+    /** Fee Sponsor id. */
     id: string;
+    /** Nickname for the Fee Sponsor. This is displayed on the transfer modal in the dashboard. */
     name?: string | undefined;
+    /** Id of the wallet that is used to sponsor the fee for other wallets */
     walletId: string;
+    /** Network used for the wallet. */
     network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
+    /** Fee sponsor status. */
     status: "Active" | "Deactivated" | "Archived";
     dateCreated: string;
+    /** Defines whether EndUsers and their delegated wallets can use this Fee Sponsor. */
     allowEndUser?: boolean | undefined;
 };
 export type CreateFeeSponsorRequest = {
     body: CreateFeeSponsorBody;
 };
 export type DeactivateFeeSponsorParams = {
+    /** Which Fee Sponsor you wish to deactivate. */
     feeSponsorId: string;
 };
 export type DeactivateFeeSponsorResponse = {
+    /** Fee Sponsor id. */
     id: string;
+    /** Nickname for the Fee Sponsor. This is displayed on the transfer modal in the dashboard. */
     name?: string | undefined;
+    /** Id of the wallet that is used to sponsor the fee for other wallets */
     walletId: string;
+    /** Network used for the wallet. */
     network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
+    /** Fee sponsor status. */
     status: "Active" | "Deactivated" | "Archived";
     dateCreated: string;
+    /** Defines whether EndUsers and their delegated wallets can use this Fee Sponsor. */
     allowEndUser?: boolean | undefined;
 };
 export type DeactivateFeeSponsorRequest = DeactivateFeeSponsorParams;
 export type DeleteFeeSponsorParams = {
+    /** Which Fee Sponsor you wish to delete. */
     feeSponsorId: string;
 };
 export type DeleteFeeSponsorResponse = {
+    /** Fee Sponsor id. */
     id: string;
+    /** Nickname for the Fee Sponsor. This is displayed on the transfer modal in the dashboard. */
     name?: string | undefined;
+    /** Id of the wallet that is used to sponsor the fee for other wallets */
     walletId: string;
+    /** Network used for the wallet. */
     network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
+    /** Fee sponsor status. */
     status: "Active" | "Deactivated" | "Archived";
     dateCreated: string;
+    /** Defines whether EndUsers and their delegated wallets can use this Fee Sponsor. */
     allowEndUser?: boolean | undefined;
 };
 export type DeleteFeeSponsorRequest = DeleteFeeSponsorParams;
 export type GetFeeSponsorParams = {
+    /** Which Fee Sponsor you wish to retrieve. */
     feeSponsorId: string;
 };
 export type GetFeeSponsorResponse = {
+    /** Fee Sponsor id. */
     id: string;
+    /** Nickname for the Fee Sponsor. This is displayed on the transfer modal in the dashboard. */
     name?: string | undefined;
+    /** Id of the wallet that is used to sponsor the fee for other wallets */
     walletId: string;
+    /** Network used for the wallet. */
     network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
+    /** Fee sponsor status. */
     status: "Active" | "Deactivated" | "Archived";
     dateCreated: string;
+    /** Defines whether EndUsers and their delegated wallets can use this Fee Sponsor. */
     allowEndUser?: boolean | undefined;
 };
 export type GetFeeSponsorRequest = GetFeeSponsorParams;
@@ -73,12 +110,18 @@ export type ListFeeSponsorsQuery = {
 };
 export type ListFeeSponsorsResponse = {
     items: {
+        /** Fee Sponsor id. */
         id: string;
+        /** Nickname for the Fee Sponsor. This is displayed on the transfer modal in the dashboard. */
         name?: string | undefined;
+        /** Id of the wallet that is used to sponsor the fee for other wallets */
         walletId: string;
+        /** Network used for the wallet. */
         network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
+        /** Fee sponsor status. */
         status: "Active" | "Deactivated" | "Archived";
         dateCreated: string;
+        /** Defines whether EndUsers and their delegated wallets can use this Fee Sponsor. */
         allowEndUser?: boolean | undefined;
     }[];
     nextPageToken?: string | undefined;
@@ -87,6 +130,7 @@ export type ListFeeSponsorsRequest = {
     query?: ListFeeSponsorsQuery;
 };
 export type ListSponsoredFeesParams = {
+    /** Fee Sponsor to retrieve the fees from. */
     feeSponsorId: string;
 };
 export type ListSponsoredFeesQuery = {
@@ -95,13 +139,16 @@ export type ListSponsoredFeesQuery = {
 };
 export type ListSponsoredFeesResponse = {
     items: {
-        id: string;
+        /** Fee Sponsor id. */
+        feeSponsorId: string;
+        /** Id of the entity being sponsored, e.g. a wallet id. */
         sponsoreeId: string;
+        /** Id of the request that was sponsored. */
         requestId: string;
-        status: "Pending" | "Confirmed";
+        /** Fee amount that was paid for the request */
         fee?: string | undefined;
         dateRequested: string;
-        dateConfirmed?: string | undefined;
+        dateConfirmed: string;
     }[];
     nextPageToken?: string | undefined;
 };