@dfns/sdk 0.8.24 → 0.8.25

package/generated/payins/types.d.ts

@@ -0,0 +1,45 @@
+export type CreatePayinRecipientBody = {
+    provider: "CircleMint";
+    /** The wallet to register as a Circle Mint recipient. */
+    walletId: string;
+    /** Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC). */
+    currency: "USD" | "EUR";
+};
+export type CreatePayinRecipientResponse = {
+    /** Payin provider. */
+    provider: "CircleMint";
+    /** The wallet whose address is (to be) registered as a recipient. */
+    walletId: string;
+    /** Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC). */
+    currency: "USD" | "EUR";
+    /** Recipient status. */
+    status: "NotRegistered" | "PendingVerification" | "Active";
+    /** The provider's recipient-registry id, once registered. */
+    recipientAddressId?: string | undefined;
+};
+export type CreatePayinRecipientRequest = {
+    body: CreatePayinRecipientBody;
+};
+export type GetPayinRecipientQuery = {
+    /** The payin provider to check the recipient with. */
+    provider: "CircleMint";
+    /** The wallet whose recipient status to check. */
+    walletId: string;
+    /** Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC). */
+    currency: "USD" | "EUR";
+};
+export type GetPayinRecipientResponse = {
+    /** Payin provider. */
+    provider: "CircleMint";
+    /** The wallet whose address is (to be) registered as a recipient. */
+    walletId: string;
+    /** Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC). */
+    currency: "USD" | "EUR";
+    /** Recipient status. */
+    status: "NotRegistered" | "PendingVerification" | "Active";
+    /** The provider's recipient-registry id, once registered. */
+    recipientAddressId?: string | undefined;
+};
+export type GetPayinRecipientRequest = {
+    query?: GetPayinRecipientQuery;
+};

package/generated/payins/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/generated/payouts/types.d.ts

@@ -28,6 +28,38 @@ export type CreatePayoutBody = {
     paymentInstructionsId: string;
     /** Borderless reason/purpose for the 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";
+} | {
+    /** The wallet ID to remit funds from. */
+    walletId: string;
+    /** Optional idempotency key to ensure only one payout is created. */
+    externalId?: string | undefined;
+    /** The asset to be paid out. */
+    asset: {
+        kind: "Erc20";
+        /** The amount of the asset to be paid out in minimum denomination. */
+        amount: string;
+        /** The ERC-20 contract address. */
+        contract: string;
+    } | {
+        kind: "Spl" | "Spl2022";
+        /** The amount of the asset to be paid out in minimum denomination. */
+        amount: string;
+        /** The token mint address. */
+        mint: string;
+    };
+    /** ISO-4217 fiat currency code for the payout. */
+    fiatCurrency: string;
+    provider: "CircleMint";
+    /** Where the redeemed fiat goes: 'bank' wires it to a linked bank account; 'balance' holds it in the org's Circle Mint balance. */
+    destination: {
+        type: "bank";
+        /** The Circle Mint bank account id to pay out to (the org links banks on Circle's website). */
+        bankId: string;
+        /** The Circle Mint payout rail. */
+        rail: "wire" | "sepa" | "sepa_instant";
+    } | {
+        type: "balance";
+    };
 };
 export type CreatePayoutResponse = {
     /** Payout id. */
@@ -113,6 +145,88 @@ export type CreatePayoutResponse = {
         dateDepositConfirmed?: string | undefined;
         datePayoutConfirmed?: string | undefined;
     };
+} | {
+    /** 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" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "BesuTestnet2" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinTestnet4" | "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" | "IconTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Movement" | "MovementTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Robinhood" | "RobinhoodSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "TezosShadownet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia" | "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" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "BesuTestnet2" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinTestnet4" | "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" | "IconTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Movement" | "MovementTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Robinhood" | "RobinhoodSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "TezosShadownet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia" | "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: "CircleMint";
+    /** Circle Mint provider-specific payout data. */
+    data: {
+        /** The Circle Mint execution status. */
+        executionStatus: "Initializing" | "AwaitingDeposit" | "DepositConfirmed" | "AwaitingPayout" | "Completed" | "Rejected" | "Failed" | "Expired" | "Canceled";
+        /** Reason for the current status, primarily for failure cases. */
+        statusReason?: string | undefined;
+        /** The Circle Mint bank account id the fiat is paid out to; absent for a balance destination. */
+        bankId?: string | undefined;
+        /** The payout rail; absent for a balance destination. */
+        rail?: ("wire" | "sepa" | "sepa_instant") | undefined;
+        /** Circle payment intent id (the unique per-operation deposit intent). */
+        paymentIntentId?: string | undefined;
+        /** The unique per-operation address the wallet remits USDC/EURC to. */
+        depositAddress?: string | undefined;
+        /** The Dfns transfer id used to send funds to the deposit address. */
+        transferId?: string | undefined;
+        /** The blockchain transaction hash of the deposit transfer. */
+        transactionHash?: string | undefined;
+        /** The id assigned by Circle when the fiat payout is created. */
+        circlePayoutId?: string | undefined;
+        /** Circle tracking reference for the fiat payout. */
+        trackingRef?: string | undefined;
+        dateDepositConfirmed?: string | undefined;
+        datePayoutConfirmed?: string | undefined;
+    };
 };
 export type CreatePayoutRequest = {
     body: CreatePayoutBody;
@@ -172,10 +286,30 @@ export type CreatePayoutQuoteBody = {
     provider: "Borderless";
     /** ISO-3166 Alpha-2 country code for the payout destination. */
     country: string;
+} | {
+    /** The wallet ID to use for determining the network. */
+    walletId: string;
+    /** The asset to be paid out. */
+    asset: {
+        kind: "Erc20";
+        /** The amount of the asset to be paid out in minimum denomination. */
+        amount: string;
+        /** The ERC-20 contract address. */
+        contract: string;
+    } | {
+        kind: "Spl" | "Spl2022";
+        /** The amount of the asset to be paid out in minimum denomination. */
+        amount: string;
+        /** The token mint address. */
+        mint: string;
+    };
+    /** ISO-4217 fiat currency code for the payout quote. */
+    fiatCurrency: string;
+    provider: "CircleMint";
 };
 export type CreatePayoutQuoteResponse = {
     /** Payout provider. */
-    provider: "Borderless";
+    provider: "Borderless" | "CircleMint";
     /** The asset being quoted, enriched with network and metadata. */
     asset: {
         kind: "Erc20";
@@ -320,6 +454,88 @@ export type GetPayoutResponse = {
         dateDepositConfirmed?: string | undefined;
         datePayoutConfirmed?: string | undefined;
     };
+} | {
+    /** 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" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "BesuTestnet2" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinTestnet4" | "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" | "IconTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Movement" | "MovementTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Robinhood" | "RobinhoodSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "TezosShadownet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia" | "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" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "BesuTestnet2" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinTestnet4" | "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" | "IconTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Movement" | "MovementTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Robinhood" | "RobinhoodSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "TezosShadownet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia" | "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: "CircleMint";
+    /** Circle Mint provider-specific payout data. */
+    data: {
+        /** The Circle Mint execution status. */
+        executionStatus: "Initializing" | "AwaitingDeposit" | "DepositConfirmed" | "AwaitingPayout" | "Completed" | "Rejected" | "Failed" | "Expired" | "Canceled";
+        /** Reason for the current status, primarily for failure cases. */
+        statusReason?: string | undefined;
+        /** The Circle Mint bank account id the fiat is paid out to; absent for a balance destination. */
+        bankId?: string | undefined;
+        /** The payout rail; absent for a balance destination. */
+        rail?: ("wire" | "sepa" | "sepa_instant") | undefined;
+        /** Circle payment intent id (the unique per-operation deposit intent). */
+        paymentIntentId?: string | undefined;
+        /** The unique per-operation address the wallet remits USDC/EURC to. */
+        depositAddress?: string | undefined;
+        /** The Dfns transfer id used to send funds to the deposit address. */
+        transferId?: string | undefined;
+        /** The blockchain transaction hash of the deposit transfer. */
+        transactionHash?: string | undefined;
+        /** The id assigned by Circle when the fiat payout is created. */
+        circlePayoutId?: string | undefined;
+        /** Circle tracking reference for the fiat payout. */
+        trackingRef?: string | undefined;
+        dateDepositConfirmed?: string | undefined;
+        datePayoutConfirmed?: string | undefined;
+    };
 };
 export type GetPayoutRequest = GetPayoutParams;
 export type ListPayoutsQuery = {
@@ -331,6 +547,8 @@ export type ListPayoutsQuery = {
     walletId?: string | undefined;
     /** Filter payouts by status (comma-separated). */
     status?: ("Processing" | "Completed" | "Failed" | "Rejected" | "Expired" | "Canceled")[] | undefined;
+    /** Filter payouts by provider (comma-separated). */
+    provider?: ("Borderless" | "CircleMint")[] | undefined;
 };
 export type ListPayoutsResponse = {
     /** Current page items. */
@@ -418,6 +636,88 @@ export type ListPayoutsResponse = {
             dateDepositConfirmed?: string | undefined;
             datePayoutConfirmed?: string | undefined;
         };
+    } | {
+        /** 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" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "BesuTestnet2" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinTestnet4" | "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" | "IconTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Movement" | "MovementTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Robinhood" | "RobinhoodSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "TezosShadownet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia" | "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" | "Areum" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "BesuTestnet" | "BesuTestnet2" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinTestnet4" | "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" | "IconTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Movement" | "MovementTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "Rayls" | "RaylsTestnet" | "Robinhood" | "RobinhoodSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "TezosShadownet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "Xdc" | "XdcApothem" | "XLayer" | "XLayerSepolia" | "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: "CircleMint";
+        /** Circle Mint provider-specific payout data. */
+        data: {
+            /** The Circle Mint execution status. */
+            executionStatus: "Initializing" | "AwaitingDeposit" | "DepositConfirmed" | "AwaitingPayout" | "Completed" | "Rejected" | "Failed" | "Expired" | "Canceled";
+            /** Reason for the current status, primarily for failure cases. */
+            statusReason?: string | undefined;
+            /** The Circle Mint bank account id the fiat is paid out to; absent for a balance destination. */
+            bankId?: string | undefined;
+            /** The payout rail; absent for a balance destination. */
+            rail?: ("wire" | "sepa" | "sepa_instant") | undefined;
+            /** Circle payment intent id (the unique per-operation deposit intent). */
+            paymentIntentId?: string | undefined;
+            /** The unique per-operation address the wallet remits USDC/EURC to. */
+            depositAddress?: string | undefined;
+            /** The Dfns transfer id used to send funds to the deposit address. */
+            transferId?: string | undefined;
+            /** The blockchain transaction hash of the deposit transfer. */
+            transactionHash?: string | undefined;
+            /** The id assigned by Circle when the fiat payout is created. */
+            circlePayoutId?: string | undefined;
+            /** Circle tracking reference for the fiat payout. */
+            trackingRef?: string | undefined;
+            dateDepositConfirmed?: string | undefined;
+            datePayoutConfirmed?: string | undefined;
+        };
     })[];
     /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;

package/generated/permissions/types.d.ts

@@ -52,7 +52,7 @@ 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" | "KeyStores:Fleets:Create" | "KeyStores:Fleets:Clone" | "KeyStores:Fleets:AddMacUser" | "KeyStores:ProofOfControl:Create" | "KeyStores:OnchainSignatures:Create" | "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:Transactions:Abort" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Transfers:Abort" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Vaults:Create" | "Vaults:Read" | "Vaults:Update" | "Vaults:Tags:Add" | "Vaults:Tags:Delete" | "Vaults:Addresses:Create" | "Vaults:Balances:Unquarantine" | "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"))[];
+    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" | "Payins:Create" | "Payins:Read" | "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" | "KeyStores:Fleets:Create" | "KeyStores:Fleets:Clone" | "KeyStores:Fleets:AddMacUser" | "KeyStores:ProofOfControl:Create" | "KeyStores:OnchainSignatures:Create" | "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:Transactions:Abort" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Transfers:Abort" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Vaults:Create" | "Vaults:Read" | "Vaults:Update" | "Vaults:Tags:Add" | "Vaults:Tags:Delete" | "Vaults:Addresses:Create" | "Vaults:Balances:Unquarantine" | "Vaults:Transfers:Create" | "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). */
@@ -270,7 +270,7 @@ 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" | "KeyStores:Fleets:Create" | "KeyStores:Fleets:Clone" | "KeyStores:Fleets:AddMacUser" | "KeyStores:ProofOfControl:Create" | "KeyStores:OnchainSignatures:Create" | "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:Transactions:Abort" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Transfers:Abort" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Vaults:Create" | "Vaults:Read" | "Vaults:Update" | "Vaults:Tags:Add" | "Vaults:Tags:Delete" | "Vaults:Addresses:Create" | "Vaults:Balances:Unquarantine" | "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;
+    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" | "Payins:Create" | "Payins:Read" | "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" | "KeyStores:Fleets:Create" | "KeyStores:Fleets:Clone" | "KeyStores:Fleets:AddMacUser" | "KeyStores:ProofOfControl:Create" | "KeyStores:OnchainSignatures:Create" | "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:Transactions:Abort" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Transfers:Abort" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Vaults:Create" | "Vaults:Read" | "Vaults:Update" | "Vaults:Tags:Add" | "Vaults:Tags:Delete" | "Vaults:Addresses:Create" | "Vaults:Balances:Unquarantine" | "Vaults:Transfers:Create" | "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). */