@dfns/sdk 0.8.12 → 0.8.13

package/generated/auth/client.js

@@ -72,7 +72,7 @@ class AuthClient {
     async archiveServiceAccount(request) {
         const path = (0, url_1.buildPathAndQuery)('/auth/service-accounts/:serviceAccountId', {
             path: request ?? {},
-            query: {},
+            query: request.query ?? {},
         });
         const response = await (0, userActionFetch_1.userActionFetch)(path, {
             method: 'DELETE',
@@ -336,7 +336,7 @@ class AuthClient {
         });
         const response = await (0, userActionFetch_1.userActionFetch)(path, {
             method: 'PUT',
-            body: {},
+            body: request.body,
             apiOptions: this.apiOptions,
         });
         return response.json();

package/generated/auth/delegatedClient.js

@@ -146,7 +146,7 @@ class DelegatedAuthClient {
     async archiveServiceAccountInit(request) {
         const path = (0, url_1.buildPathAndQuery)('/auth/service-accounts/:serviceAccountId', {
             path: request ?? {},
-            query: {},
+            query: request.query ?? {},
         });
         const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
             userActionHttpMethod: 'DELETE',
@@ -159,7 +159,7 @@ class DelegatedAuthClient {
     async archiveServiceAccountComplete(request, signedChallenge) {
         const path = (0, url_1.buildPathAndQuery)('/auth/service-accounts/:serviceAccountId', {
             path: request ?? {},
-            query: {},
+            query: request.query ?? {},
         });
         const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
         const response = await (0, fetch_1.simpleFetch)(path, {
@@ -564,7 +564,7 @@ class DelegatedAuthClient {
         const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
             userActionHttpMethod: 'PUT',
             userActionHttpPath: path,
-            userActionPayload: JSON.stringify({}),
+            userActionPayload: JSON.stringify(request.body),
             userActionServerKind: 'Api',
         }, this.apiOptions);
         return challenge;
@@ -577,7 +577,7 @@ class DelegatedAuthClient {
         const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
         const response = await (0, fetch_1.simpleFetch)(path, {
             method: 'PUT',
-            body: {},
+            body: request.body,
             headers: { 'x-dfns-useraction': userAction },
             apiOptions: this.apiOptions,
         });

package/generated/auth/types.d.ts

@@ -129,6 +129,10 @@ export type ArchivePersonalAccessTokenRequest = ArchivePersonalAccessTokenParams
 export type ArchiveServiceAccountParams = {
     serviceAccountId: string;
 };
+export type ArchiveServiceAccountQuery = {
+    /** If true, bypasses the policy approver check and deletes immediately. */
+    force?: boolean;
+};
 export type ArchiveServiceAccountResponse = {
     userInfo: {
         username: string;
@@ -171,7 +175,9 @@ export type ArchiveServiceAccountResponse = {
         tokenId: string;
     }[];
 };
-export type ArchiveServiceAccountRequest = ArchiveServiceAccountParams;
+export type ArchiveServiceAccountRequest = ArchiveServiceAccountParams & {
+    query?: ArchiveServiceAccountQuery;
+};
 export type ArchiveUserParams = {
     userId: string;
 };
@@ -1329,6 +1335,10 @@ export type DeactivatePersonalAccessTokenResponse = {
     tokenId: string;
 };
 export type DeactivatePersonalAccessTokenRequest = DeactivatePersonalAccessTokenParams;
+export type DeactivateServiceAccountBody = {
+    /** If true, bypasses the policy approver check and deactivates immediately. */
+    force?: boolean;
+};
 export type DeactivateServiceAccountParams = {
     serviceAccountId: string;
 };
@@ -1374,7 +1384,9 @@ export type DeactivateServiceAccountResponse = {
         tokenId: string;
     }[];
 };
-export type DeactivateServiceAccountRequest = DeactivateServiceAccountParams;
+export type DeactivateServiceAccountRequest = DeactivateServiceAccountParams & {
+    body: DeactivateServiceAccountBody;
+};
 export type DeactivateUserParams = {
     userId: string;
 };

package/generated/networks/types.d.ts

@@ -120,7 +120,7 @@ export type GetCantonValidatorResponse = {
 };
 export type GetCantonValidatorRequest = GetCantonValidatorParams;
 export type GetFeesQuery = {
-    network: "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "AvalancheC" | "AvalancheCFuji" | "Base" | "BaseGoerli" | "BaseSepolia" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Ink" | "InkSepolia" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Race" | "RaceSepolia" | "Sonic" | "SonicTestnet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1";
+    network: "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "AvalancheC" | "AvalancheCFuji" | "Base" | "BaseGoerli" | "BaseSepolia" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Ink" | "InkSepolia" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Race" | "RaceSepolia" | "Sonic" | "SonicTestnet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Solana" | "SolanaDevnet";
 };
 export type GetFeesResponse = {
     kind: "Bitcoin";
@@ -155,6 +155,19 @@ export type GetFeesResponse = {
         maxFeePerGas: string;
     };
     baseFeePerGas: string;
+} | {
+    kind: "Solana";
+    network: "Solana" | "SolanaDevnet";
+    blockNumber: number;
+    slow: {
+        computeUnitPrice: string;
+    };
+    standard: {
+        computeUnitPrice: string;
+    };
+    fast: {
+        computeUnitPrice: string;
+    };
 };
 export type GetFeesRequest = {
     query?: GetFeesQuery;

package/generated/payouts/client.d.ts

@@ -7,4 +7,5 @@ export declare class PayoutsClient {
     createPayoutAction(request: T.CreatePayoutActionRequest): Promise<T.CreatePayoutActionResponse>;
     createPayoutQuote(request: T.CreatePayoutQuoteRequest): Promise<T.CreatePayoutQuoteResponse>;
     getPayout(request: T.GetPayoutRequest): Promise<T.GetPayoutResponse>;
+    listPayouts(request?: T.ListPayoutsRequest): Promise<T.ListPayoutsResponse>;
 }

package/generated/payouts/client.js

@@ -56,5 +56,16 @@ class PayoutsClient {
         });
         return response.json();
     }
+    async listPayouts(request) {
+        const path = (0, url_1.buildPathAndQuery)('/payouts', {
+            path: request ?? {},
+            query: request?.query ?? {},
+        });
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'GET',
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
 }
 exports.PayoutsClient = PayoutsClient;

package/generated/payouts/delegatedClient.d.ts

@@ -10,4 +10,5 @@ export declare class DelegatedPayoutsClient {
     createPayoutActionComplete(request: T.CreatePayoutActionRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.CreatePayoutActionResponse>;
     createPayoutQuote(request: T.CreatePayoutQuoteRequest): Promise<T.CreatePayoutQuoteResponse>;
     getPayout(request: T.GetPayoutRequest): Promise<T.GetPayoutResponse>;
+    listPayouts(request?: T.ListPayoutsRequest): Promise<T.ListPayoutsResponse>;
 }

package/generated/payouts/delegatedClient.js

@@ -85,5 +85,16 @@ class DelegatedPayoutsClient {
         });
         return response.json();
     }
+    async listPayouts(request) {
+        const path = (0, url_1.buildPathAndQuery)('/payouts', {
+            path: request ?? {},
+            query: request?.query ?? {},
+        });
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'GET',
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
 }
 exports.DelegatedPayoutsClient = DelegatedPayoutsClient;

package/generated/payouts/types.d.ts

@@ -322,3 +322,106 @@ export type GetPayoutResponse = {
     };
 };
 export type GetPayoutRequest = GetPayoutParams;
+export type ListPayoutsQuery = {
+    /** 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 payouts by wallet ID. */
+    walletId?: string | undefined;
+    /** Filter payouts by status (comma-separated). */
+    status?: ("Processing" | "Completed" | "Failed" | "Rejected" | "Expired" | "Canceled")[] | undefined;
+};
+export type ListPayoutsResponse = {
+    /** Current page items. */
+    items: ({
+        /** Payout id. */
+        id: string;
+        /** The wallet ID used for the payout. */
+        walletId: string;
+        /** ISO-4217 fiat currency code for the payout. */
+        fiatCurrency: string;
+        /** The asset being paid out, including token descriptor and metadata. */
+        asset: {
+            kind: "Erc20";
+            /** The amount of the asset to be paid out in minimum denomination. */
+            amount: string;
+            /** The ERC-20 contract address. */
+            contract: string;
+            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" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "XrpLedger" | "XrpLedgerTestnet";
+            metadata?: {
+                /** The display name of the token. */
+                name?: string | undefined;
+                /** The ticker symbol of the token. */
+                symbol?: string | undefined;
+                /** Number of decimals used by the token. */
+                decimals: number;
+                /** Whether the token is verified by DFNS as legitimate. */
+                verified?: boolean | undefined;
+            } | undefined;
+        } | {
+            kind: "Spl" | "Spl2022";
+            /** The amount of the asset to be paid out in minimum denomination. */
+            amount: string;
+            /** The token mint address. */
+            mint: string;
+            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" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "XrpLedger" | "XrpLedgerTestnet";
+            metadata?: {
+                /** The display name of the token. */
+                name?: string | undefined;
+                /** The ticker symbol of the token. */
+                symbol?: string | undefined;
+                /** Number of decimals used by the token. */
+                decimals: number;
+                /** Whether the token is verified by DFNS as legitimate. */
+                verified?: boolean | undefined;
+            } | undefined;
+        };
+        /** Optional external identifier for idempotency. */
+        externalId?: string | undefined;
+        /** The current status of the payout. */
+        status: "Processing" | "Completed" | "Failed" | "Rejected" | "Expired" | "Canceled";
+        /** The user/token that initiated the payout. */
+        requester: {
+            /** User id. */
+            userId: string;
+            /** Token id. */
+            tokenId?: string | undefined;
+        };
+        dateCreated: string;
+        dateFinalized?: string | undefined;
+        provider: "Borderless";
+        /** Borderless provider-specific payout data. */
+        data: {
+            /** The Borderless account ID associated with the payout. */
+            borderlessAccountId: string;
+            /** The Borderless payment instructions ID linked to the destination bank account. */
+            paymentInstructionsId: string;
+            /** The purpose of the withdrawal payment. */
+            paymentPurpose: "salary payment" | "personal remittance" | "rent payment" | "property purchase" | "owned account abroad" | "advertising expenses" | "advisory fees" | "business insurance" | "construction" | "delivery fees" | "education" | "exports" | "donation" | "hotel" | "loan payment" | "maintenance expenses" | "medical expense" | "office expenses" | "royalty fees" | "service charge" | "shares investment" | "tax payment" | "transportation fees" | "travel" | "utility bills" | "other";
+            dateConfirmed?: string | undefined;
+            dateCanceled?: string | undefined;
+            /** The Borderless execution status. */
+            executionStatus: "Initializing" | "AwaitingPayoutInstructions" | "AwaitingPayoutConfirmation" | "SubmittingPayoutTransfer" | "PendingPolicyApproval" | "DepositProcessing" | "DisbursementPending" | "Completed" | "Rejected" | "Failed" | "Expired" | "Canceled";
+            /** Reason for the current status, primarily for failure cases. */
+            statusReason?: string | undefined;
+            /** ISO-3166 Alpha-2 country code for the payout destination. */
+            country: string;
+            /** The ID assigned by Borderless when the payout is created. */
+            borderlessPayoutId?: string | undefined;
+            /** The on-chain address to remit funds to. */
+            depositAddress?: string | undefined;
+            /** The Dfns transfer ID used to settle the payout. */
+            transferId?: string | undefined;
+            /** The blockchain transaction hash once the transfer is confirmed. */
+            transactionHash?: string | undefined;
+            dateDepositConfirmed?: string | undefined;
+            datePayoutConfirmed?: string | undefined;
+        };
+    })[];
+    /** token to use as `paginationToken` to request the next page. */
+    nextPageToken?: string | undefined;
+};
+export type ListPayoutsRequest = {
+    query?: ListPayoutsQuery;
+};

package/generated/permissions/client.js

@@ -70,7 +70,7 @@ class PermissionsClient {
     async listAssignments(request) {
         const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments', {
             path: request ?? {},
-            query: {},
+            query: request.query ?? {},
         });
         const response = await (0, fetch_1.simpleFetch)(path, {
             method: 'GET',

package/generated/permissions/delegatedClient.js

@@ -129,7 +129,7 @@ class DelegatedPermissionsClient {
     async listAssignments(request) {
         const path = (0, url_1.buildPathAndQuery)('/permissions/:permissionId/assignments', {
             path: request ?? {},
-            query: {},
+            query: request.query ?? {},
         });
         const response = await (0, fetch_1.simpleFetch)(path, {
             method: 'GET',

package/generated/permissions/types.d.ts

@@ -1,15 +1,23 @@
 export type ArchivePermissionBody = {
+    /** Set to true to archive, false to unarchive. */
     isArchived: boolean;
 };
 export type ArchivePermissionParams = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     permissionId: string;
 };
 export type ArchivePermissionResponse = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     id: string;
+    /** Human-readable name of the permission (role). */
     name: string;
+    /** List of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
     operations: string[];
+    /** Current status of the permission. */
     status: "Active";
+    /** Whether this permission is system-managed and cannot be modified. */
     isImmutable: boolean;
+    /** Whether this permission has been archived (soft-deleted). */
     isArchived: boolean;
     dateCreated: string;
     dateUpdated: string;
@@ -18,15 +26,21 @@ export type ArchivePermissionRequest = ArchivePermissionParams & {
     body: ArchivePermissionBody;
 };
 export type CreateAssignmentBody = {
+    /** ID of the identity to assign the permission to. Can be a user ID, a service account ID, or a personal access token (PAT) ID. */
     identityId: string;
 };
 export type CreateAssignmentParams = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     permissionId: string;
 };
 export type CreateAssignmentResponse = {
+    /** ID of the permission assignment. */
     id: string;
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     permissionId: string;
+    /** ID of the identity the permission is assigned to. Can be a user ID, a service account ID, or a personal access token (PAT) ID. */
     identityId: string;
+    /** Whether this assignment is system-managed and cannot be modified. */
     isImmutable: boolean;
     dateCreated: string;
     dateUpdated: string;
@@ -35,15 +49,23 @@ export type CreateAssignmentRequest = CreateAssignmentParams & {
     body: CreateAssignmentBody;
 };
 export type CreatePermissionBody = {
+    /** Human-readable name for the permission (role). */
     name: string;
+    /** List of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
     operations: (("Registry:Addresses:Create" | "Registry:Addresses:Delete" | "Registry:Addresses:Read" | "Registry:Addresses:Update" | "Registry:ContractSchemas:Create" | "Registry:ContractSchemas:Delete" | "Registry:ContractSchemas:Read" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Update" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Events:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "FeeSponsors:Use" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Payouts:Create" | "Payouts:Read" | "Payouts:Write" | "Allocations:Create" | "Allocations:Update" | "Allocations:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:ChildKeys:Create" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "KeyStores:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Vaults:Create" | "Vaults:Read" | "Vaults:Update" | "Vaults:Tags:Add" | "Vaults:Tags:Delete" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[];
 };
 export type CreatePermissionResponse = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     id: string;
+    /** Human-readable name of the permission (role). */
     name: string;
+    /** List of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
     operations: string[];
+    /** Current status of the permission. */
     status: "Active";
+    /** Whether this permission is system-managed and cannot be modified. */
     isImmutable: boolean;
+    /** Whether this permission has been archived (soft-deleted). */
     isArchived: boolean;
     dateCreated: string;
     dateUpdated: string;
@@ -52,10 +74,13 @@ export type CreatePermissionRequest = {
     body: CreatePermissionBody;
 };
 export type DeleteAssignmentParams = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     permissionId: string;
+    /** ID of the permission assignment. */
     assignmentId: string;
 };
 export type DeleteAssignmentQuery = {
+    /** If true, bypasses the approval process and revokes immediately. */
     force?: boolean | undefined;
 };
 export type DeleteAssignmentResponse = void | undefined;
@@ -63,19 +88,27 @@ export type DeleteAssignmentRequest = DeleteAssignmentParams & {
     query?: DeleteAssignmentQuery;
 };
 export type GetPermissionParams = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     permissionId: string;
 };
 export type GetPermissionResponse = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     id: string;
+    /** Human-readable name of the permission (role). */
     name: string;
+    /** List of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
     operations: string[];
+    /** Current status of the permission. */
     status: "Active";
+    /** Whether this permission is system-managed and cannot be modified. */
     isImmutable: boolean;
+    /** Whether this permission has been archived (soft-deleted). */
     isArchived: boolean;
     dateCreated: string;
     dateUpdated: string;
 } & {
     pendingChangeRequest?: {
+        /** ID of the change request. */
         id: string;
         /** The user who initiated the change request. */
         requester: {
@@ -83,7 +116,9 @@ export type GetPermissionResponse = {
             tokenId?: string | undefined;
             appId?: string | undefined;
         };
+        /** Current status of the change request. */
         status: "Applied" | "Failed" | "Pending" | "Rejected";
+        /** ID of the entity being changed. */
         entityId: string;
         dateCreated: string;
         dateResolved?: string | undefined;
@@ -91,29 +126,48 @@ export type GetPermissionResponse = {
         kind: "Permission";
         operationKind: "Update";
         body: {
+            /** ID of the permission (also referred to as "role" in the dashboard). */
             id: string;
+            /** Human-readable name of the permission (role). */
             name: string;
+            /** Current status of the permission. */
             status: "Active";
+            /** List of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
             operations: string[];
+            /** Whether this permission is system-managed and cannot be modified. */
             isImmutable: boolean;
+            /** Whether this permission has been archived (soft-deleted). */
             isArchived: boolean;
         };
     } | undefined;
 };
 export type GetPermissionRequest = GetPermissionParams;
 export type ListAssignmentsParams = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     permissionId: string;
 };
+export type ListAssignmentsQuery = {
+    /** 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 ListAssignmentsResponse = {
+    /** Current page items. */
     items: ({
+        /** ID of the permission assignment. */
         id: string;
+        /** ID of the permission (also referred to as "role" in the dashboard). */
         permissionId: string;
+        /** ID of the identity the permission is assigned to. Can be a user ID, a service account ID, or a personal access token (PAT) ID. */
         identityId: string;
+        /** Whether this assignment is system-managed and cannot be modified. */
         isImmutable: boolean;
         dateCreated: string;
         dateUpdated: string;
     } & {
         pendingChangeRequest?: {
+            /** ID of the change request. */
             id: string;
             /** The user who initiated the change request. */
             requester: {
@@ -121,7 +175,9 @@ export type ListAssignmentsResponse = {
                 tokenId?: string | undefined;
                 appId?: string | undefined;
             };
+            /** Current status of the change request. */
             status: "Applied" | "Failed" | "Pending" | "Rejected";
+            /** ID of the entity being changed. */
             entityId: string;
             dateCreated: string;
             dateResolved?: string | undefined;
@@ -129,32 +185,49 @@ export type ListAssignmentsResponse = {
             kind: "Assignment";
             operationKind: "Create" | "Delete";
             body: {
+                /** ID of the permission assignment. */
                 id: string;
+                /** ID of the permission (also referred to as "role" in the dashboard). */
                 permissionId: string;
+                /** ID of the identity the permission is assigned to. Can be a user ID, a service account ID, or a personal access token (PAT) ID. */
                 identityId: string;
+                /** Whether this assignment is system-managed and cannot be modified. */
                 isImmutable: boolean;
             };
         } | undefined;
     })[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
-export type ListAssignmentsRequest = ListAssignmentsParams;
+export type ListAssignmentsRequest = ListAssignmentsParams & {
+    query?: ListAssignmentsQuery;
+};
 export type ListPermissionsQuery = {
-    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 ListPermissionsResponse = {
+    /** Current page items. */
     items: ({
+        /** ID of the permission (also referred to as "role" in the dashboard). */
         id: string;
+        /** Human-readable name of the permission (role). */
         name: string;
+        /** List of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
         operations: string[];
+        /** Current status of the permission. */
         status: "Active";
+        /** Whether this permission is system-managed and cannot be modified. */
         isImmutable: boolean;
+        /** Whether this permission has been archived (soft-deleted). */
         isArchived: boolean;
         dateCreated: string;
         dateUpdated: string;
     } & {
         pendingChangeRequest?: {
+            /** ID of the change request. */
             id: string;
             /** The user who initiated the change request. */
             requester: {
@@ -162,7 +235,9 @@ export type ListPermissionsResponse = {
                 tokenId?: string | undefined;
                 appId?: string | undefined;
             };
+            /** Current status of the change request. */
             status: "Applied" | "Failed" | "Pending" | "Rejected";
+            /** ID of the entity being changed. */
             entityId: string;
             dateCreated: string;
             dateResolved?: string | undefined;
@@ -170,33 +245,49 @@ export type ListPermissionsResponse = {
             kind: "Permission";
             operationKind: "Update";
             body: {
+                /** ID of the permission (also referred to as "role" in the dashboard). */
                 id: string;
+                /** Human-readable name of the permission (role). */
                 name: string;
+                /** Current status of the permission. */
                 status: "Active";
+                /** List of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
                 operations: string[];
+                /** Whether this permission is system-managed and cannot be modified. */
                 isImmutable: boolean;
+                /** Whether this permission has been archived (soft-deleted). */
                 isArchived: boolean;
             };
         } | undefined;
     })[];
+    /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;
 };
 export type ListPermissionsRequest = {
     query?: ListPermissionsQuery;
 };
 export type UpdatePermissionBody = {
+    /** New name for the permission (role). */
     name?: string | undefined;
+    /** New list of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
     operations?: (("Registry:Addresses:Create" | "Registry:Addresses:Delete" | "Registry:Addresses:Read" | "Registry:Addresses:Update" | "Registry:ContractSchemas:Create" | "Registry:ContractSchemas:Delete" | "Registry:ContractSchemas:Read" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Update" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Events:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "FeeSponsors:Use" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Payouts:Create" | "Payouts:Read" | "Payouts:Write" | "Allocations:Create" | "Allocations:Update" | "Allocations:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:ChildKeys:Create" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "KeyStores:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Vaults:Create" | "Vaults:Read" | "Vaults:Update" | "Vaults:Tags:Add" | "Vaults:Tags:Delete" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[] | undefined;
 };
 export type UpdatePermissionParams = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     permissionId: string;
 };
 export type UpdatePermissionResponse = {
+    /** ID of the permission (also referred to as "role" in the dashboard). */
     id: string;
+    /** Human-readable name of the permission (role). */
     name: string;
+    /** List of API operations this permission grants access to. See [Permissions List](https://docs.dfns.co/core-concepts/roles-and-permissions#list-of-permissions) for available operations. */
     operations: string[];
+    /** Current status of the permission. */
     status: "Active";
+    /** Whether this permission is system-managed and cannot be modified. */
     isImmutable: boolean;
+    /** Whether this permission has been archived (soft-deleted). */
     isArchived: boolean;
     dateCreated: string;
     dateUpdated: string;