/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { AddressReverseLookupResponse } from '../models'; import { AutomationSettingsRequest } from '../models'; import { AutomationSettingsResponse } from '../models'; import { CreateAddressRequest } from '../models'; import { CreateAddressResponse } from '../models'; import { CreateAssetsRequest } from '../models'; import { CreateMultipleAccountsRequest } from '../models'; import { CreateMultipleDepositAddressesJobStatus } from '../models'; import { CreateMultipleDepositAddressesRequest } from '../models'; import { CreateMultipleVaultAccountsJobStatus } from '../models'; import { CreateVaultAccountRequest } from '../models'; import { CreateVaultAssetResponse } from '../models'; import { GetAutomationSettingsResponse } from '../models'; import { GetMaxBipIndexUsedResponse } from '../models'; import { GetMaxSpendableAmountResponse } from '../models'; import { GetUnspentInputsResponse } from '../models'; import { GetVaultAssetsResponse } from '../models'; import { JobCreated } from '../models'; import { PaginatedAddressResponse } from '../models'; import { PaginatedAssetWalletResponse } from '../models'; import { PublicKeyInformation } from '../models'; import { RenameVaultAccountResponse } from '../models'; import { SaveAutomationSettingsResponse } from '../models'; import { SetAutoFuelRequest } from '../models'; import { SetCustomerRefIdForAddressRequest } from '../models'; import { SetCustomerRefIdRequest } from '../models'; import { UpdateAutomationSettingsRequest } from '../models'; import { UpdateVaultAccountAssetAddressRequest } from '../models'; import { UpdateVaultAccountRequest } from '../models'; import { UsdcGatewayWalletInfoResponse } from '../models'; import { UsdcGatewayWalletStatusResponse } from '../models'; import { VaultAccount } from '../models'; import { VaultAccountsPagedResponse } from '../models'; import { VaultAccountsTagAttachmentOperationsRequest } from '../models'; import { VaultAccountsTagAttachmentOperationsResponse } from '../models'; import { VaultActionStatus } from '../models'; import { VaultAsset } from '../models'; /** * VaultsApi - axios parameter creator * @export */ export declare const VaultsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Initiates activation for a wallet in a vault account. Activation is required for tokens that need an on-chain transaction for creation. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Activate a wallet in a vault account * @param {string} vaultAccountId The ID of the vault account to return, or \'default\' for the default vault account * @param {string} assetId The ID of the asset * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {string} [blockchainWalletType] Optional immutable blockchain wallet type to store per tenant+vault * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateAssetForVaultAccount: (vaultAccountId: string, assetId: string, idempotencyKey?: string, blockchainWalletType?: string, options?: RawAxiosRequestConfig) => Promise; /** * Activates the USDC Gateway wallet associated with the given vault account. If the wallet does not yet exist it is created in an activated state. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Activate a USDC Gateway wallet * @param {string} vaultAccountId The ID of the vault account * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateUsdcGatewayWalletBeta: (vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Attach or detach one or more tags from the requested vault accounts. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver. * @summary Attach or detach tags from vault accounts * @param {VaultAccountsTagAttachmentOperationsRequest} vaultAccountsTagAttachmentOperationsRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachOrDetachTagsFromVaultAccounts: (vaultAccountsTagAttachmentOperationsRequest: VaultAccountsTagAttachmentOperationsRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Converts an existing segwit address to the legacy format. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Convert a segwit address to legacy format * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {string} addressId The segwit address to translate * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLegacyAddress: (vaultAccountId: string, assetId: string, addressId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Bulk creation of new vault accounts * @param {CreateMultipleAccountsRequest} createMultipleAccountsRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMultipleAccounts: (createMultipleAccountsRequest: CreateMultipleAccountsRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * **For UTXO blockchains only.** Create multiple deposit addresses by running an async job. - The target Vault account should already have a UTXO asset wallet with a permanent address. - Limited to a maximum of 10,000 addresses per operation. Use multiple operations for the same Vault account/permanent address if needed. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Bulk creation of new deposit addresses * @param {CreateMultipleDepositAddressesRequest} createMultipleDepositAddressesRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMultipleDepositAddresses: (createMultipleDepositAddressesRequest: CreateMultipleDepositAddressesRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new vault account with the requested name. **Note: ** Vault account names should consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Create a new vault account * @param {CreateVaultAccountRequest} createVaultAccountRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccount: (createVaultAccountRequest: CreateVaultAccountRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Create a new vault wallet * @param {string} vaultAccountId The ID of the vault account to return, or \'default\' for the default vault account * @param {string} assetId The ID of the asset * @param {CreateAssetsRequest} [createAssetsRequest] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {string} [blockchainWalletType] Optional immutable blockchain wallet type to store per tenant+vault * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccountAsset: (vaultAccountId: string, assetId: string, createAssetsRequest?: CreateAssetsRequest, idempotencyKey?: string, blockchainWalletType?: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new deposit address for an asset of a vault account. Should be used for UTXO or Tag/Memo based assets ONLY. Requests with account based assets will fail. Endpoint Permission: Admin, Non-Signing Admin. * @summary Create new asset deposit address * @param {string} vaultAccountId The ID of the vault account to return * @param {string} assetId The ID of the asset * @param {CreateAddressRequest} [createAddressRequest] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccountAssetAddress: (vaultAccountId: string, assetId: string, createAddressRequest?: CreateAddressRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Deactivates the USDC Gateway wallet associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Deactivate a USDC Gateway wallet * @param {string} vaultAccountId The ID of the vault account * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateUsdcGatewayWalletBeta: (vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Stops the schedule for an existing deposit automation. The automation itself stays configured, only its schedule stops. Turn it back on later with PATCH, without setting up the automation again from scratch. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Stop a USDC Gateway deposit automation\'s schedule * @param {string} vaultAccountId The ID of the vault account * @param {string} automationId The ID of the deposit automation, returned when it was created or read * @param {*} [options] Override http request option. * @throws {RequiredError} */ disableUsdcGatewayDepositAutomationScheduleBeta: (vaultAccountId: string, automationId: string, options?: RawAxiosRequestConfig) => Promise; /** * Get all vault wallets of the vault accounts in your workspace. A vault wallet is an asset in a vault account. This method allows fast traversal of all account balances. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault wallets (Paginated) * @param {number} [totalAmountLargerThan] When specified, only vault wallets with total balance greater than this amount are returned. * @param {string} [assetId] When specified, only vault wallets with the specified ID are returned. * @param {GetAssetWalletsOrderByEnum} [orderBy] * @param {string} [before] Fetches the next paginated response before this element. This element is a cursor and is returned at the response of the previous page. * @param {string} [after] Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page. * @param {number} [limit] The maximum number of vault wallets in a single response. The default is 200 and the maximum is 1000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAssetWallets: (totalAmountLargerThan?: number, assetId?: string, orderBy?: GetAssetWalletsOrderByEnum, before?: string, after?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns the current status of (or an error for) the specified deposit addresss bulk creation job. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. * @summary Get the job status of the bulk deposit address creation * @param {string} jobId The ID of the job to create addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreateMultipleDepositAddressesJobStatus: (jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the current status of (or error for) the specified vault account bulk creation job. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get job status of bulk creation of new vault accounts * @param {string} jobId The ID of the job to create addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreateMultipleVaultAccountsJobStatus: (jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the maximum BIP44 address index and change address index used for a specific asset in a vault account (BIP44 standard). * @summary Get maximum BIP44 index used * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxBipIndexUsed: (vaultAccountId: string, assetId: string, options?: RawAxiosRequestConfig) => Promise; /** * **UTXO assets only.** Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get max spendable amount in a transaction * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {boolean} [manualSignging] False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device. * @param {Array} [includeAllLabels] Only include UTXOs that have ALL of these labels (AND logic). Requires the UTXO Manager. * @param {Array} [includeAnyLabels] Only include UTXOs that have ANY of these labels (OR logic). Requires the UTXO Manager. * @param {Array} [excludeAnyLabels] Exclude UTXOs that have ANY of these labels. Requires the UTXO Manager. * @param {string} [address] Only include UTXOs from this specific address. Requires the UTXO Manager. * @param {string} [minAmount] Minimum UTXO amount in the asset\'s base unit. Requires the UTXO Manager. * @param {string} [maxAmount] Maximum UTXO amount in the asset\'s base unit. Requires the UTXO Manager. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxSpendableAmount: (vaultAccountId: string, assetId: string, manualSignging?: boolean, includeAllLabels?: Array, includeAnyLabels?: Array, excludeAnyLabels?: Array, address?: string, minAmount?: string, maxAmount?: string, options?: RawAxiosRequestConfig) => Promise; /** * Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault accounts (Paginated) * @param {string} [namePrefix] * @param {string} [nameSuffix] * @param {number} [minAmountThreshold] Specifying minAmountThreshold will filter accounts whose total balance is greater than this value; otherwise, it returns all accounts. The amount set in this parameter represents the native asset amount, not its USD value. * @param {string} [assetId] * @param {GetPagedVaultAccountsOrderByEnum} [orderBy] * @param {string} [before] * @param {string} [after] * @param {number} [limit] * @param {Array} [tagIds] DEPRECATED - use includeTagIds instead * @param {Array} [includeTagIds] List of tag IDs to include. Vault accounts with any of these tags will be included * @param {Array} [excludeTagIds] List of tag IDs to exclude. Vault accounts with any of these tags will be filtered out * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPagedVaultAccounts: (namePrefix?: string, nameSuffix?: string, minAmountThreshold?: number, assetId?: string, orderBy?: GetPagedVaultAccountsOrderByEnum, before?: string, after?: string, limit?: number, tagIds?: Array, includeTagIds?: Array, excludeTagIds?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Gets the public key information based on derivation path and signing algorithm. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get the public key for a derivation path * @param {string} derivationPath * @param {string} algorithm * @param {boolean} [compressed] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicKeyInfo: (derivationPath: string, algorithm: string, compressed?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get the public key information for a specific asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get an asset\'s public key * @param {string} vaultAccountId * @param {string} assetId * @param {number} change * @param {number} addressIndex * @param {boolean} [compressed] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicKeyInfoForAddress: (vaultAccountId: string, assetId: string, change: number, addressIndex: number, compressed?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Returns unspent inputs information of an UTXO asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get UTXO unspent inputs information * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnspentInputs: (vaultAccountId: string, assetId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the USDC Gateway deposit automations configured for the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Read the USDC Gateway deposit automations for a vault account * @param {string} vaultAccountId The ID of the vault account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsdcGatewayDepositAutomationBeta: (vaultAccountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the USDC Gateway wallet information associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get USDC Gateway wallet info * @param {string} vaultAccountId The ID of the vault account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsdcGatewayWalletInfoBeta: (vaultAccountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a vault account by its unique ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get a vault account by ID * @param {string} vaultAccountId The ID of the vault account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccount: (vaultAccountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a specific vault wallet balance information for a specific asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get the asset balance for a vault account * @param {string} vaultAccountId The ID of the vault account to return * @param {string} assetId The ID of the asset * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccountAsset: (vaultAccountId: string, assetId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated response of the addresses for a given vault account and asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get addresses (Paginated) * @param {string} vaultAccountId The ID of the vault account to return * @param {string} assetId The ID of the asset * @param {number} [limit] * @param {string} [before] * @param {string} [after] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccountAssetAddressesPaginated: (vaultAccountId: string, assetId: string, limit?: number, before?: string, after?: string, options?: RawAxiosRequestConfig) => Promise; /** * Gets the assets amount summary for all accounts or filtered accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get asset balance for chosen assets * @param {string} [accountNamePrefix] * @param {string} [accountNameSuffix] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAssets: (accountNamePrefix?: string, accountNameSuffix?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the total balance of an asset across all the vault accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault balance by an asset * @param {string} assetId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultBalanceByAsset: (assetId: string, options?: RawAxiosRequestConfig) => Promise; /** * Hides the requested vault account from the web console view. This operation is required when creating thousands of vault accounts to serve your end-users. Used for preventing the web console to be swamped with too much vault accounts. Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Hide a vault account in the console * @param {string} vaultAccountId The vault account to hide * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ hideVaultAccount: (vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Resolves a blockchain address to the vault account that owns it. Returns the vault account ID and the blockchains associated with the address. **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Look up a vault account by blockchain address * @param {string} address The blockchain address to resolve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ lookupVaultByAddress: (address: string, options?: RawAxiosRequestConfig) => Promise; /** * Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign AML customer reference ID * @param {SetCustomerRefIdForAddressRequest} setCustomerRefIdForAddressRequest * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {string} addressId The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setCustomerRefIdForAddress: (setCustomerRefIdForAddressRequest: SetCustomerRefIdForAddressRequest, vaultAccountId: string, assetId: string, addressId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Turns on automatic deposits into the USDC Gateway wallet for the given vault account, on the schedule you choose. Returns an error if an automation already exists for this vault account and asset. Use PATCH to change it instead. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Set up a USDC Gateway deposit automation for a vault account * @param {AutomationSettingsRequest} automationSettingsRequest * @param {string} vaultAccountId The ID of the vault account * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setUsdcGatewayDepositAutomationBeta: (automationSettingsRequest: AutomationSettingsRequest, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Toggles the auto fueling property of the vault account to enabled or disabled. Vault Accounts with \'autoFuel=true\' are monitored and auto fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Set auto fueling to on or off * @param {SetAutoFuelRequest} setAutoFuelRequest * @param {string} vaultAccountId The vault account ID * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaultAccountAutoFuel: (setAutoFuelRequest: SetAutoFuelRequest, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Assigns an AML/KYT customer reference ID for the vault account. Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies). Endpoint Permission: Admin, Non-Signing Admin. * @summary Set an AML/KYT ID for a vault account * @param {SetCustomerRefIdRequest} setCustomerRefIdRequest * @param {string} vaultAccountId The vault account ID * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaultAccountCustomerRefId: (setCustomerRefIdRequest: SetCustomerRefIdRequest, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Makes a hidden vault account visible in web console view. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Unhide a vault account in the console * @param {string} vaultAccountId The vault account to unhide * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unhideVaultAccount: (vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Changes an existing USDC Gateway deposit automation for a vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Change a USDC Gateway deposit automation * @param {UpdateAutomationSettingsRequest} updateAutomationSettingsRequest * @param {string} vaultAccountId The ID of the vault account * @param {string} automationId The ID of the deposit automation, returned when it was created or read * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUsdcGatewayDepositAutomationBeta: (updateAutomationSettingsRequest: UpdateAutomationSettingsRequest, vaultAccountId: string, automationId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Renames the requested vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Rename a vault account * @param {UpdateVaultAccountRequest} updateVaultAccountRequest * @param {string} vaultAccountId The ID of the vault account to edit * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccount: (updateVaultAccountRequest: UpdateVaultAccountRequest, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates the description of an existing address of an asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Update address description * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {string} addressId The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address * @param {UpdateVaultAccountAssetAddressRequest} [updateVaultAccountAssetAddressRequest] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccountAssetAddress: (vaultAccountId: string, assetId: string, addressId: string, updateVaultAccountAssetAddressRequest?: UpdateVaultAccountAssetAddressRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates the balance of a specific asset in a vault account. This API endpoint is subject to a strict rate limit. Should be used by clients in very specific scenarios. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Refresh asset balance data * @param {string} vaultAccountId The ID of the vault account to return * @param {string} assetId The ID of the asset * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccountAssetBalance: (vaultAccountId: string, assetId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * VaultsApi - functional programming interface * @export */ export declare const VaultsApiFp: (configuration?: Configuration) => { /** * Initiates activation for a wallet in a vault account. Activation is required for tokens that need an on-chain transaction for creation. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Activate a wallet in a vault account * @param {string} vaultAccountId The ID of the vault account to return, or \'default\' for the default vault account * @param {string} assetId The ID of the asset * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {string} [blockchainWalletType] Optional immutable blockchain wallet type to store per tenant+vault * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateAssetForVaultAccount(vaultAccountId: string, assetId: string, idempotencyKey?: string, blockchainWalletType?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Activates the USDC Gateway wallet associated with the given vault account. If the wallet does not yet exist it is created in an activated state. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Activate a USDC Gateway wallet * @param {string} vaultAccountId The ID of the vault account * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateUsdcGatewayWalletBeta(vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Attach or detach one or more tags from the requested vault accounts. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver. * @summary Attach or detach tags from vault accounts * @param {VaultAccountsTagAttachmentOperationsRequest} vaultAccountsTagAttachmentOperationsRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachOrDetachTagsFromVaultAccounts(vaultAccountsTagAttachmentOperationsRequest: VaultAccountsTagAttachmentOperationsRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Converts an existing segwit address to the legacy format. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Convert a segwit address to legacy format * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {string} addressId The segwit address to translate * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLegacyAddress(vaultAccountId: string, assetId: string, addressId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Bulk creation of new vault accounts * @param {CreateMultipleAccountsRequest} createMultipleAccountsRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMultipleAccounts(createMultipleAccountsRequest: CreateMultipleAccountsRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * **For UTXO blockchains only.** Create multiple deposit addresses by running an async job. - The target Vault account should already have a UTXO asset wallet with a permanent address. - Limited to a maximum of 10,000 addresses per operation. Use multiple operations for the same Vault account/permanent address if needed. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Bulk creation of new deposit addresses * @param {CreateMultipleDepositAddressesRequest} createMultipleDepositAddressesRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMultipleDepositAddresses(createMultipleDepositAddressesRequest: CreateMultipleDepositAddressesRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new vault account with the requested name. **Note: ** Vault account names should consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Create a new vault account * @param {CreateVaultAccountRequest} createVaultAccountRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccount(createVaultAccountRequest: CreateVaultAccountRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Create a new vault wallet * @param {string} vaultAccountId The ID of the vault account to return, or \'default\' for the default vault account * @param {string} assetId The ID of the asset * @param {CreateAssetsRequest} [createAssetsRequest] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {string} [blockchainWalletType] Optional immutable blockchain wallet type to store per tenant+vault * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccountAsset(vaultAccountId: string, assetId: string, createAssetsRequest?: CreateAssetsRequest, idempotencyKey?: string, blockchainWalletType?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new deposit address for an asset of a vault account. Should be used for UTXO or Tag/Memo based assets ONLY. Requests with account based assets will fail. Endpoint Permission: Admin, Non-Signing Admin. * @summary Create new asset deposit address * @param {string} vaultAccountId The ID of the vault account to return * @param {string} assetId The ID of the asset * @param {CreateAddressRequest} [createAddressRequest] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccountAssetAddress(vaultAccountId: string, assetId: string, createAddressRequest?: CreateAddressRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deactivates the USDC Gateway wallet associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Deactivate a USDC Gateway wallet * @param {string} vaultAccountId The ID of the vault account * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateUsdcGatewayWalletBeta(vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Stops the schedule for an existing deposit automation. The automation itself stays configured, only its schedule stops. Turn it back on later with PATCH, without setting up the automation again from scratch. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Stop a USDC Gateway deposit automation\'s schedule * @param {string} vaultAccountId The ID of the vault account * @param {string} automationId The ID of the deposit automation, returned when it was created or read * @param {*} [options] Override http request option. * @throws {RequiredError} */ disableUsdcGatewayDepositAutomationScheduleBeta(vaultAccountId: string, automationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all vault wallets of the vault accounts in your workspace. A vault wallet is an asset in a vault account. This method allows fast traversal of all account balances. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault wallets (Paginated) * @param {number} [totalAmountLargerThan] When specified, only vault wallets with total balance greater than this amount are returned. * @param {string} [assetId] When specified, only vault wallets with the specified ID are returned. * @param {GetAssetWalletsOrderByEnum} [orderBy] * @param {string} [before] Fetches the next paginated response before this element. This element is a cursor and is returned at the response of the previous page. * @param {string} [after] Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page. * @param {number} [limit] The maximum number of vault wallets in a single response. The default is 200 and the maximum is 1000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAssetWallets(totalAmountLargerThan?: number, assetId?: string, orderBy?: GetAssetWalletsOrderByEnum, before?: string, after?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the current status of (or an error for) the specified deposit addresss bulk creation job. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. * @summary Get the job status of the bulk deposit address creation * @param {string} jobId The ID of the job to create addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreateMultipleDepositAddressesJobStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the current status of (or error for) the specified vault account bulk creation job. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get job status of bulk creation of new vault accounts * @param {string} jobId The ID of the job to create addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreateMultipleVaultAccountsJobStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the maximum BIP44 address index and change address index used for a specific asset in a vault account (BIP44 standard). * @summary Get maximum BIP44 index used * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxBipIndexUsed(vaultAccountId: string, assetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * **UTXO assets only.** Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get max spendable amount in a transaction * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {boolean} [manualSignging] False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device. * @param {Array} [includeAllLabels] Only include UTXOs that have ALL of these labels (AND logic). Requires the UTXO Manager. * @param {Array} [includeAnyLabels] Only include UTXOs that have ANY of these labels (OR logic). Requires the UTXO Manager. * @param {Array} [excludeAnyLabels] Exclude UTXOs that have ANY of these labels. Requires the UTXO Manager. * @param {string} [address] Only include UTXOs from this specific address. Requires the UTXO Manager. * @param {string} [minAmount] Minimum UTXO amount in the asset\'s base unit. Requires the UTXO Manager. * @param {string} [maxAmount] Maximum UTXO amount in the asset\'s base unit. Requires the UTXO Manager. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxSpendableAmount(vaultAccountId: string, assetId: string, manualSignging?: boolean, includeAllLabels?: Array, includeAnyLabels?: Array, excludeAnyLabels?: Array, address?: string, minAmount?: string, maxAmount?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault accounts (Paginated) * @param {string} [namePrefix] * @param {string} [nameSuffix] * @param {number} [minAmountThreshold] Specifying minAmountThreshold will filter accounts whose total balance is greater than this value; otherwise, it returns all accounts. The amount set in this parameter represents the native asset amount, not its USD value. * @param {string} [assetId] * @param {GetPagedVaultAccountsOrderByEnum} [orderBy] * @param {string} [before] * @param {string} [after] * @param {number} [limit] * @param {Array} [tagIds] DEPRECATED - use includeTagIds instead * @param {Array} [includeTagIds] List of tag IDs to include. Vault accounts with any of these tags will be included * @param {Array} [excludeTagIds] List of tag IDs to exclude. Vault accounts with any of these tags will be filtered out * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPagedVaultAccounts(namePrefix?: string, nameSuffix?: string, minAmountThreshold?: number, assetId?: string, orderBy?: GetPagedVaultAccountsOrderByEnum, before?: string, after?: string, limit?: number, tagIds?: Array, includeTagIds?: Array, excludeTagIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the public key information based on derivation path and signing algorithm. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get the public key for a derivation path * @param {string} derivationPath * @param {string} algorithm * @param {boolean} [compressed] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicKeyInfo(derivationPath: string, algorithm: string, compressed?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the public key information for a specific asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get an asset\'s public key * @param {string} vaultAccountId * @param {string} assetId * @param {number} change * @param {number} addressIndex * @param {boolean} [compressed] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicKeyInfoForAddress(vaultAccountId: string, assetId: string, change: number, addressIndex: number, compressed?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns unspent inputs information of an UTXO asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get UTXO unspent inputs information * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnspentInputs(vaultAccountId: string, assetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the USDC Gateway deposit automations configured for the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Read the USDC Gateway deposit automations for a vault account * @param {string} vaultAccountId The ID of the vault account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsdcGatewayDepositAutomationBeta(vaultAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the USDC Gateway wallet information associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get USDC Gateway wallet info * @param {string} vaultAccountId The ID of the vault account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsdcGatewayWalletInfoBeta(vaultAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a vault account by its unique ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get a vault account by ID * @param {string} vaultAccountId The ID of the vault account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccount(vaultAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a specific vault wallet balance information for a specific asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get the asset balance for a vault account * @param {string} vaultAccountId The ID of the vault account to return * @param {string} assetId The ID of the asset * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccountAsset(vaultAccountId: string, assetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated response of the addresses for a given vault account and asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get addresses (Paginated) * @param {string} vaultAccountId The ID of the vault account to return * @param {string} assetId The ID of the asset * @param {number} [limit] * @param {string} [before] * @param {string} [after] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccountAssetAddressesPaginated(vaultAccountId: string, assetId: string, limit?: number, before?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the assets amount summary for all accounts or filtered accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get asset balance for chosen assets * @param {string} [accountNamePrefix] * @param {string} [accountNameSuffix] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAssets(accountNamePrefix?: string, accountNameSuffix?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the total balance of an asset across all the vault accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault balance by an asset * @param {string} assetId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultBalanceByAsset(assetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Hides the requested vault account from the web console view. This operation is required when creating thousands of vault accounts to serve your end-users. Used for preventing the web console to be swamped with too much vault accounts. Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Hide a vault account in the console * @param {string} vaultAccountId The vault account to hide * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ hideVaultAccount(vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resolves a blockchain address to the vault account that owns it. Returns the vault account ID and the blockchains associated with the address. **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Look up a vault account by blockchain address * @param {string} address The blockchain address to resolve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ lookupVaultByAddress(address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign AML customer reference ID * @param {SetCustomerRefIdForAddressRequest} setCustomerRefIdForAddressRequest * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {string} addressId The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setCustomerRefIdForAddress(setCustomerRefIdForAddressRequest: SetCustomerRefIdForAddressRequest, vaultAccountId: string, assetId: string, addressId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Turns on automatic deposits into the USDC Gateway wallet for the given vault account, on the schedule you choose. Returns an error if an automation already exists for this vault account and asset. Use PATCH to change it instead. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Set up a USDC Gateway deposit automation for a vault account * @param {AutomationSettingsRequest} automationSettingsRequest * @param {string} vaultAccountId The ID of the vault account * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setUsdcGatewayDepositAutomationBeta(automationSettingsRequest: AutomationSettingsRequest, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Toggles the auto fueling property of the vault account to enabled or disabled. Vault Accounts with \'autoFuel=true\' are monitored and auto fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Set auto fueling to on or off * @param {SetAutoFuelRequest} setAutoFuelRequest * @param {string} vaultAccountId The vault account ID * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaultAccountAutoFuel(setAutoFuelRequest: SetAutoFuelRequest, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Assigns an AML/KYT customer reference ID for the vault account. Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies). Endpoint Permission: Admin, Non-Signing Admin. * @summary Set an AML/KYT ID for a vault account * @param {SetCustomerRefIdRequest} setCustomerRefIdRequest * @param {string} vaultAccountId The vault account ID * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaultAccountCustomerRefId(setCustomerRefIdRequest: SetCustomerRefIdRequest, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Makes a hidden vault account visible in web console view. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Unhide a vault account in the console * @param {string} vaultAccountId The vault account to unhide * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unhideVaultAccount(vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Changes an existing USDC Gateway deposit automation for a vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Change a USDC Gateway deposit automation * @param {UpdateAutomationSettingsRequest} updateAutomationSettingsRequest * @param {string} vaultAccountId The ID of the vault account * @param {string} automationId The ID of the deposit automation, returned when it was created or read * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUsdcGatewayDepositAutomationBeta(updateAutomationSettingsRequest: UpdateAutomationSettingsRequest, vaultAccountId: string, automationId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Renames the requested vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Rename a vault account * @param {UpdateVaultAccountRequest} updateVaultAccountRequest * @param {string} vaultAccountId The ID of the vault account to edit * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccount(updateVaultAccountRequest: UpdateVaultAccountRequest, vaultAccountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the description of an existing address of an asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Update address description * @param {string} vaultAccountId The ID of the vault account * @param {string} assetId The ID of the asset * @param {string} addressId The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address * @param {UpdateVaultAccountAssetAddressRequest} [updateVaultAccountAssetAddressRequest] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccountAssetAddress(vaultAccountId: string, assetId: string, addressId: string, updateVaultAccountAssetAddressRequest?: UpdateVaultAccountAssetAddressRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the balance of a specific asset in a vault account. This API endpoint is subject to a strict rate limit. Should be used by clients in very specific scenarios. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Refresh asset balance data * @param {string} vaultAccountId The ID of the vault account to return * @param {string} assetId The ID of the asset * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccountAssetBalance(vaultAccountId: string, assetId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VaultsApi - factory interface * @export */ export declare const VaultsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Initiates activation for a wallet in a vault account. Activation is required for tokens that need an on-chain transaction for creation. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Activate a wallet in a vault account * @param {VaultsApiActivateAssetForVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateAssetForVaultAccount(requestParameters: VaultsApiActivateAssetForVaultAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Activates the USDC Gateway wallet associated with the given vault account. If the wallet does not yet exist it is created in an activated state. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Activate a USDC Gateway wallet * @param {VaultsApiActivateUsdcGatewayWalletBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateUsdcGatewayWalletBeta(requestParameters: VaultsApiActivateUsdcGatewayWalletBetaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Attach or detach one or more tags from the requested vault accounts. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver. * @summary Attach or detach tags from vault accounts * @param {VaultsApiAttachOrDetachTagsFromVaultAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachOrDetachTagsFromVaultAccounts(requestParameters: VaultsApiAttachOrDetachTagsFromVaultAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Converts an existing segwit address to the legacy format. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Convert a segwit address to legacy format * @param {VaultsApiCreateLegacyAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLegacyAddress(requestParameters: VaultsApiCreateLegacyAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Bulk creation of new vault accounts * @param {VaultsApiCreateMultipleAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMultipleAccounts(requestParameters: VaultsApiCreateMultipleAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * **For UTXO blockchains only.** Create multiple deposit addresses by running an async job. - The target Vault account should already have a UTXO asset wallet with a permanent address. - Limited to a maximum of 10,000 addresses per operation. Use multiple operations for the same Vault account/permanent address if needed. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Bulk creation of new deposit addresses * @param {VaultsApiCreateMultipleDepositAddressesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMultipleDepositAddresses(requestParameters: VaultsApiCreateMultipleDepositAddressesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new vault account with the requested name. **Note: ** Vault account names should consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Create a new vault account * @param {VaultsApiCreateVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccount(requestParameters: VaultsApiCreateVaultAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Create a new vault wallet * @param {VaultsApiCreateVaultAccountAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccountAsset(requestParameters: VaultsApiCreateVaultAccountAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new deposit address for an asset of a vault account. Should be used for UTXO or Tag/Memo based assets ONLY. Requests with account based assets will fail. Endpoint Permission: Admin, Non-Signing Admin. * @summary Create new asset deposit address * @param {VaultsApiCreateVaultAccountAssetAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createVaultAccountAssetAddress(requestParameters: VaultsApiCreateVaultAccountAssetAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deactivates the USDC Gateway wallet associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Deactivate a USDC Gateway wallet * @param {VaultsApiDeactivateUsdcGatewayWalletBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateUsdcGatewayWalletBeta(requestParameters: VaultsApiDeactivateUsdcGatewayWalletBetaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Stops the schedule for an existing deposit automation. The automation itself stays configured, only its schedule stops. Turn it back on later with PATCH, without setting up the automation again from scratch. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Stop a USDC Gateway deposit automation\'s schedule * @param {VaultsApiDisableUsdcGatewayDepositAutomationScheduleBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disableUsdcGatewayDepositAutomationScheduleBeta(requestParameters: VaultsApiDisableUsdcGatewayDepositAutomationScheduleBetaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get all vault wallets of the vault accounts in your workspace. A vault wallet is an asset in a vault account. This method allows fast traversal of all account balances. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault wallets (Paginated) * @param {VaultsApiGetAssetWalletsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAssetWallets(requestParameters?: VaultsApiGetAssetWalletsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the current status of (or an error for) the specified deposit addresss bulk creation job. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. * @summary Get the job status of the bulk deposit address creation * @param {VaultsApiGetCreateMultipleDepositAddressesJobStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreateMultipleDepositAddressesJobStatus(requestParameters: VaultsApiGetCreateMultipleDepositAddressesJobStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the current status of (or error for) the specified vault account bulk creation job. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get job status of bulk creation of new vault accounts * @param {VaultsApiGetCreateMultipleVaultAccountsJobStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreateMultipleVaultAccountsJobStatus(requestParameters: VaultsApiGetCreateMultipleVaultAccountsJobStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the maximum BIP44 address index and change address index used for a specific asset in a vault account (BIP44 standard). * @summary Get maximum BIP44 index used * @param {VaultsApiGetMaxBipIndexUsedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxBipIndexUsed(requestParameters: VaultsApiGetMaxBipIndexUsedRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * **UTXO assets only.** Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get max spendable amount in a transaction * @param {VaultsApiGetMaxSpendableAmountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxSpendableAmount(requestParameters: VaultsApiGetMaxSpendableAmountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault accounts (Paginated) * @param {VaultsApiGetPagedVaultAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPagedVaultAccounts(requestParameters?: VaultsApiGetPagedVaultAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets the public key information based on derivation path and signing algorithm. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get the public key for a derivation path * @param {VaultsApiGetPublicKeyInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicKeyInfo(requestParameters: VaultsApiGetPublicKeyInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the public key information for a specific asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get an asset\'s public key * @param {VaultsApiGetPublicKeyInfoForAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicKeyInfoForAddress(requestParameters: VaultsApiGetPublicKeyInfoForAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns unspent inputs information of an UTXO asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get UTXO unspent inputs information * @param {VaultsApiGetUnspentInputsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnspentInputs(requestParameters: VaultsApiGetUnspentInputsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the USDC Gateway deposit automations configured for the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Read the USDC Gateway deposit automations for a vault account * @param {VaultsApiGetUsdcGatewayDepositAutomationBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsdcGatewayDepositAutomationBeta(requestParameters: VaultsApiGetUsdcGatewayDepositAutomationBetaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the USDC Gateway wallet information associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get USDC Gateway wallet info * @param {VaultsApiGetUsdcGatewayWalletInfoBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsdcGatewayWalletInfoBeta(requestParameters: VaultsApiGetUsdcGatewayWalletInfoBetaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a vault account by its unique ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get a vault account by ID * @param {VaultsApiGetVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccount(requestParameters: VaultsApiGetVaultAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a specific vault wallet balance information for a specific asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get the asset balance for a vault account * @param {VaultsApiGetVaultAccountAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccountAsset(requestParameters: VaultsApiGetVaultAccountAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated response of the addresses for a given vault account and asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get addresses (Paginated) * @param {VaultsApiGetVaultAccountAssetAddressesPaginatedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAccountAssetAddressesPaginated(requestParameters: VaultsApiGetVaultAccountAssetAddressesPaginatedRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets the assets amount summary for all accounts or filtered accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get asset balance for chosen assets * @param {VaultsApiGetVaultAssetsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultAssets(requestParameters?: VaultsApiGetVaultAssetsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the total balance of an asset across all the vault accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault balance by an asset * @param {VaultsApiGetVaultBalanceByAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVaultBalanceByAsset(requestParameters: VaultsApiGetVaultBalanceByAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Hides the requested vault account from the web console view. This operation is required when creating thousands of vault accounts to serve your end-users. Used for preventing the web console to be swamped with too much vault accounts. Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Hide a vault account in the console * @param {VaultsApiHideVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ hideVaultAccount(requestParameters: VaultsApiHideVaultAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resolves a blockchain address to the vault account that owns it. Returns the vault account ID and the blockchains associated with the address. **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Look up a vault account by blockchain address * @param {VaultsApiLookupVaultByAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ lookupVaultByAddress(requestParameters: VaultsApiLookupVaultByAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign AML customer reference ID * @param {VaultsApiSetCustomerRefIdForAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setCustomerRefIdForAddress(requestParameters: VaultsApiSetCustomerRefIdForAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Turns on automatic deposits into the USDC Gateway wallet for the given vault account, on the schedule you choose. Returns an error if an automation already exists for this vault account and asset. Use PATCH to change it instead. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Set up a USDC Gateway deposit automation for a vault account * @param {VaultsApiSetUsdcGatewayDepositAutomationBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setUsdcGatewayDepositAutomationBeta(requestParameters: VaultsApiSetUsdcGatewayDepositAutomationBetaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Toggles the auto fueling property of the vault account to enabled or disabled. Vault Accounts with \'autoFuel=true\' are monitored and auto fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Set auto fueling to on or off * @param {VaultsApiSetVaultAccountAutoFuelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaultAccountAutoFuel(requestParameters: VaultsApiSetVaultAccountAutoFuelRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Assigns an AML/KYT customer reference ID for the vault account. Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies). Endpoint Permission: Admin, Non-Signing Admin. * @summary Set an AML/KYT ID for a vault account * @param {VaultsApiSetVaultAccountCustomerRefIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setVaultAccountCustomerRefId(requestParameters: VaultsApiSetVaultAccountCustomerRefIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Makes a hidden vault account visible in web console view. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Unhide a vault account in the console * @param {VaultsApiUnhideVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unhideVaultAccount(requestParameters: VaultsApiUnhideVaultAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Changes an existing USDC Gateway deposit automation for a vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Change a USDC Gateway deposit automation * @param {VaultsApiUpdateUsdcGatewayDepositAutomationBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUsdcGatewayDepositAutomationBeta(requestParameters: VaultsApiUpdateUsdcGatewayDepositAutomationBetaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Renames the requested vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Rename a vault account * @param {VaultsApiUpdateVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccount(requestParameters: VaultsApiUpdateVaultAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the description of an existing address of an asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Update address description * @param {VaultsApiUpdateVaultAccountAssetAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccountAssetAddress(requestParameters: VaultsApiUpdateVaultAccountAssetAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the balance of a specific asset in a vault account. This API endpoint is subject to a strict rate limit. Should be used by clients in very specific scenarios. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Refresh asset balance data * @param {VaultsApiUpdateVaultAccountAssetBalanceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVaultAccountAssetBalance(requestParameters: VaultsApiUpdateVaultAccountAssetBalanceRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for activateAssetForVaultAccount operation in VaultsApi. * @export * @interface VaultsApiActivateAssetForVaultAccountRequest */ export interface VaultsApiActivateAssetForVaultAccountRequest { /** * The ID of the vault account to return, or \'default\' for the default vault account * @type {string} * @memberof VaultsApiActivateAssetForVaultAccount */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiActivateAssetForVaultAccount */ readonly assetId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiActivateAssetForVaultAccount */ readonly idempotencyKey?: string; /** * Optional immutable blockchain wallet type to store per tenant+vault * @type {string} * @memberof VaultsApiActivateAssetForVaultAccount */ readonly blockchainWalletType?: string; } /** * Request parameters for activateUsdcGatewayWalletBeta operation in VaultsApi. * @export * @interface VaultsApiActivateUsdcGatewayWalletBetaRequest */ export interface VaultsApiActivateUsdcGatewayWalletBetaRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiActivateUsdcGatewayWalletBeta */ readonly vaultAccountId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiActivateUsdcGatewayWalletBeta */ readonly idempotencyKey?: string; } /** * Request parameters for attachOrDetachTagsFromVaultAccounts operation in VaultsApi. * @export * @interface VaultsApiAttachOrDetachTagsFromVaultAccountsRequest */ export interface VaultsApiAttachOrDetachTagsFromVaultAccountsRequest { /** * * @type {VaultAccountsTagAttachmentOperationsRequest} * @memberof VaultsApiAttachOrDetachTagsFromVaultAccounts */ readonly vaultAccountsTagAttachmentOperationsRequest: VaultAccountsTagAttachmentOperationsRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiAttachOrDetachTagsFromVaultAccounts */ readonly idempotencyKey?: string; } /** * Request parameters for createLegacyAddress operation in VaultsApi. * @export * @interface VaultsApiCreateLegacyAddressRequest */ export interface VaultsApiCreateLegacyAddressRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiCreateLegacyAddress */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiCreateLegacyAddress */ readonly assetId: string; /** * The segwit address to translate * @type {string} * @memberof VaultsApiCreateLegacyAddress */ readonly addressId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiCreateLegacyAddress */ readonly idempotencyKey?: string; } /** * Request parameters for createMultipleAccounts operation in VaultsApi. * @export * @interface VaultsApiCreateMultipleAccountsRequest */ export interface VaultsApiCreateMultipleAccountsRequest { /** * * @type {CreateMultipleAccountsRequest} * @memberof VaultsApiCreateMultipleAccounts */ readonly createMultipleAccountsRequest: CreateMultipleAccountsRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiCreateMultipleAccounts */ readonly idempotencyKey?: string; } /** * Request parameters for createMultipleDepositAddresses operation in VaultsApi. * @export * @interface VaultsApiCreateMultipleDepositAddressesRequest */ export interface VaultsApiCreateMultipleDepositAddressesRequest { /** * * @type {CreateMultipleDepositAddressesRequest} * @memberof VaultsApiCreateMultipleDepositAddresses */ readonly createMultipleDepositAddressesRequest: CreateMultipleDepositAddressesRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiCreateMultipleDepositAddresses */ readonly idempotencyKey?: string; } /** * Request parameters for createVaultAccount operation in VaultsApi. * @export * @interface VaultsApiCreateVaultAccountRequest */ export interface VaultsApiCreateVaultAccountRequest { /** * * @type {CreateVaultAccountRequest} * @memberof VaultsApiCreateVaultAccount */ readonly createVaultAccountRequest: CreateVaultAccountRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiCreateVaultAccount */ readonly idempotencyKey?: string; } /** * Request parameters for createVaultAccountAsset operation in VaultsApi. * @export * @interface VaultsApiCreateVaultAccountAssetRequest */ export interface VaultsApiCreateVaultAccountAssetRequest { /** * The ID of the vault account to return, or \'default\' for the default vault account * @type {string} * @memberof VaultsApiCreateVaultAccountAsset */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiCreateVaultAccountAsset */ readonly assetId: string; /** * * @type {CreateAssetsRequest} * @memberof VaultsApiCreateVaultAccountAsset */ readonly createAssetsRequest?: CreateAssetsRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiCreateVaultAccountAsset */ readonly idempotencyKey?: string; /** * Optional immutable blockchain wallet type to store per tenant+vault * @type {string} * @memberof VaultsApiCreateVaultAccountAsset */ readonly blockchainWalletType?: string; } /** * Request parameters for createVaultAccountAssetAddress operation in VaultsApi. * @export * @interface VaultsApiCreateVaultAccountAssetAddressRequest */ export interface VaultsApiCreateVaultAccountAssetAddressRequest { /** * The ID of the vault account to return * @type {string} * @memberof VaultsApiCreateVaultAccountAssetAddress */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiCreateVaultAccountAssetAddress */ readonly assetId: string; /** * * @type {CreateAddressRequest} * @memberof VaultsApiCreateVaultAccountAssetAddress */ readonly createAddressRequest?: CreateAddressRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiCreateVaultAccountAssetAddress */ readonly idempotencyKey?: string; } /** * Request parameters for deactivateUsdcGatewayWalletBeta operation in VaultsApi. * @export * @interface VaultsApiDeactivateUsdcGatewayWalletBetaRequest */ export interface VaultsApiDeactivateUsdcGatewayWalletBetaRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiDeactivateUsdcGatewayWalletBeta */ readonly vaultAccountId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiDeactivateUsdcGatewayWalletBeta */ readonly idempotencyKey?: string; } /** * Request parameters for disableUsdcGatewayDepositAutomationScheduleBeta operation in VaultsApi. * @export * @interface VaultsApiDisableUsdcGatewayDepositAutomationScheduleBetaRequest */ export interface VaultsApiDisableUsdcGatewayDepositAutomationScheduleBetaRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiDisableUsdcGatewayDepositAutomationScheduleBeta */ readonly vaultAccountId: string; /** * The ID of the deposit automation, returned when it was created or read * @type {string} * @memberof VaultsApiDisableUsdcGatewayDepositAutomationScheduleBeta */ readonly automationId: string; } /** * Request parameters for getAssetWallets operation in VaultsApi. * @export * @interface VaultsApiGetAssetWalletsRequest */ export interface VaultsApiGetAssetWalletsRequest { /** * When specified, only vault wallets with total balance greater than this amount are returned. * @type {number} * @memberof VaultsApiGetAssetWallets */ readonly totalAmountLargerThan?: number; /** * When specified, only vault wallets with the specified ID are returned. * @type {string} * @memberof VaultsApiGetAssetWallets */ readonly assetId?: string; /** * * @type {'ASC' | 'DESC'} * @memberof VaultsApiGetAssetWallets */ readonly orderBy?: GetAssetWalletsOrderByEnum; /** * Fetches the next paginated response before this element. This element is a cursor and is returned at the response of the previous page. * @type {string} * @memberof VaultsApiGetAssetWallets */ readonly before?: string; /** * Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page. * @type {string} * @memberof VaultsApiGetAssetWallets */ readonly after?: string; /** * The maximum number of vault wallets in a single response. The default is 200 and the maximum is 1000. * @type {number} * @memberof VaultsApiGetAssetWallets */ readonly limit?: number; } /** * Request parameters for getCreateMultipleDepositAddressesJobStatus operation in VaultsApi. * @export * @interface VaultsApiGetCreateMultipleDepositAddressesJobStatusRequest */ export interface VaultsApiGetCreateMultipleDepositAddressesJobStatusRequest { /** * The ID of the job to create addresses * @type {string} * @memberof VaultsApiGetCreateMultipleDepositAddressesJobStatus */ readonly jobId: string; } /** * Request parameters for getCreateMultipleVaultAccountsJobStatus operation in VaultsApi. * @export * @interface VaultsApiGetCreateMultipleVaultAccountsJobStatusRequest */ export interface VaultsApiGetCreateMultipleVaultAccountsJobStatusRequest { /** * The ID of the job to create addresses * @type {string} * @memberof VaultsApiGetCreateMultipleVaultAccountsJobStatus */ readonly jobId: string; } /** * Request parameters for getMaxBipIndexUsed operation in VaultsApi. * @export * @interface VaultsApiGetMaxBipIndexUsedRequest */ export interface VaultsApiGetMaxBipIndexUsedRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiGetMaxBipIndexUsed */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiGetMaxBipIndexUsed */ readonly assetId: string; } /** * Request parameters for getMaxSpendableAmount operation in VaultsApi. * @export * @interface VaultsApiGetMaxSpendableAmountRequest */ export interface VaultsApiGetMaxSpendableAmountRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiGetMaxSpendableAmount */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiGetMaxSpendableAmount */ readonly assetId: string; /** * False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device. * @type {boolean} * @memberof VaultsApiGetMaxSpendableAmount */ readonly manualSignging?: boolean; /** * Only include UTXOs that have ALL of these labels (AND logic). Requires the UTXO Manager. * @type {Array} * @memberof VaultsApiGetMaxSpendableAmount */ readonly includeAllLabels?: Array; /** * Only include UTXOs that have ANY of these labels (OR logic). Requires the UTXO Manager. * @type {Array} * @memberof VaultsApiGetMaxSpendableAmount */ readonly includeAnyLabels?: Array; /** * Exclude UTXOs that have ANY of these labels. Requires the UTXO Manager. * @type {Array} * @memberof VaultsApiGetMaxSpendableAmount */ readonly excludeAnyLabels?: Array; /** * Only include UTXOs from this specific address. Requires the UTXO Manager. * @type {string} * @memberof VaultsApiGetMaxSpendableAmount */ readonly address?: string; /** * Minimum UTXO amount in the asset\'s base unit. Requires the UTXO Manager. * @type {string} * @memberof VaultsApiGetMaxSpendableAmount */ readonly minAmount?: string; /** * Maximum UTXO amount in the asset\'s base unit. Requires the UTXO Manager. * @type {string} * @memberof VaultsApiGetMaxSpendableAmount */ readonly maxAmount?: string; } /** * Request parameters for getPagedVaultAccounts operation in VaultsApi. * @export * @interface VaultsApiGetPagedVaultAccountsRequest */ export interface VaultsApiGetPagedVaultAccountsRequest { /** * * @type {string} * @memberof VaultsApiGetPagedVaultAccounts */ readonly namePrefix?: string; /** * * @type {string} * @memberof VaultsApiGetPagedVaultAccounts */ readonly nameSuffix?: string; /** * Specifying minAmountThreshold will filter accounts whose total balance is greater than this value; otherwise, it returns all accounts. The amount set in this parameter represents the native asset amount, not its USD value. * @type {number} * @memberof VaultsApiGetPagedVaultAccounts */ readonly minAmountThreshold?: number; /** * * @type {string} * @memberof VaultsApiGetPagedVaultAccounts */ readonly assetId?: string; /** * * @type {'ASC' | 'DESC'} * @memberof VaultsApiGetPagedVaultAccounts */ readonly orderBy?: GetPagedVaultAccountsOrderByEnum; /** * * @type {string} * @memberof VaultsApiGetPagedVaultAccounts */ readonly before?: string; /** * * @type {string} * @memberof VaultsApiGetPagedVaultAccounts */ readonly after?: string; /** * * @type {number} * @memberof VaultsApiGetPagedVaultAccounts */ readonly limit?: number; /** * DEPRECATED - use includeTagIds instead * @type {Array} * @memberof VaultsApiGetPagedVaultAccounts */ readonly tagIds?: Array; /** * List of tag IDs to include. Vault accounts with any of these tags will be included * @type {Array} * @memberof VaultsApiGetPagedVaultAccounts */ readonly includeTagIds?: Array; /** * List of tag IDs to exclude. Vault accounts with any of these tags will be filtered out * @type {Array} * @memberof VaultsApiGetPagedVaultAccounts */ readonly excludeTagIds?: Array; } /** * Request parameters for getPublicKeyInfo operation in VaultsApi. * @export * @interface VaultsApiGetPublicKeyInfoRequest */ export interface VaultsApiGetPublicKeyInfoRequest { /** * * @type {string} * @memberof VaultsApiGetPublicKeyInfo */ readonly derivationPath: string; /** * * @type {string} * @memberof VaultsApiGetPublicKeyInfo */ readonly algorithm: string; /** * * @type {boolean} * @memberof VaultsApiGetPublicKeyInfo */ readonly compressed?: boolean; } /** * Request parameters for getPublicKeyInfoForAddress operation in VaultsApi. * @export * @interface VaultsApiGetPublicKeyInfoForAddressRequest */ export interface VaultsApiGetPublicKeyInfoForAddressRequest { /** * * @type {string} * @memberof VaultsApiGetPublicKeyInfoForAddress */ readonly vaultAccountId: string; /** * * @type {string} * @memberof VaultsApiGetPublicKeyInfoForAddress */ readonly assetId: string; /** * * @type {number} * @memberof VaultsApiGetPublicKeyInfoForAddress */ readonly change: number; /** * * @type {number} * @memberof VaultsApiGetPublicKeyInfoForAddress */ readonly addressIndex: number; /** * * @type {boolean} * @memberof VaultsApiGetPublicKeyInfoForAddress */ readonly compressed?: boolean; } /** * Request parameters for getUnspentInputs operation in VaultsApi. * @export * @interface VaultsApiGetUnspentInputsRequest */ export interface VaultsApiGetUnspentInputsRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiGetUnspentInputs */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiGetUnspentInputs */ readonly assetId: string; } /** * Request parameters for getUsdcGatewayDepositAutomationBeta operation in VaultsApi. * @export * @interface VaultsApiGetUsdcGatewayDepositAutomationBetaRequest */ export interface VaultsApiGetUsdcGatewayDepositAutomationBetaRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiGetUsdcGatewayDepositAutomationBeta */ readonly vaultAccountId: string; } /** * Request parameters for getUsdcGatewayWalletInfoBeta operation in VaultsApi. * @export * @interface VaultsApiGetUsdcGatewayWalletInfoBetaRequest */ export interface VaultsApiGetUsdcGatewayWalletInfoBetaRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiGetUsdcGatewayWalletInfoBeta */ readonly vaultAccountId: string; } /** * Request parameters for getVaultAccount operation in VaultsApi. * @export * @interface VaultsApiGetVaultAccountRequest */ export interface VaultsApiGetVaultAccountRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiGetVaultAccount */ readonly vaultAccountId: string; } /** * Request parameters for getVaultAccountAsset operation in VaultsApi. * @export * @interface VaultsApiGetVaultAccountAssetRequest */ export interface VaultsApiGetVaultAccountAssetRequest { /** * The ID of the vault account to return * @type {string} * @memberof VaultsApiGetVaultAccountAsset */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiGetVaultAccountAsset */ readonly assetId: string; } /** * Request parameters for getVaultAccountAssetAddressesPaginated operation in VaultsApi. * @export * @interface VaultsApiGetVaultAccountAssetAddressesPaginatedRequest */ export interface VaultsApiGetVaultAccountAssetAddressesPaginatedRequest { /** * The ID of the vault account to return * @type {string} * @memberof VaultsApiGetVaultAccountAssetAddressesPaginated */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiGetVaultAccountAssetAddressesPaginated */ readonly assetId: string; /** * * @type {number} * @memberof VaultsApiGetVaultAccountAssetAddressesPaginated */ readonly limit?: number; /** * * @type {string} * @memberof VaultsApiGetVaultAccountAssetAddressesPaginated */ readonly before?: string; /** * * @type {string} * @memberof VaultsApiGetVaultAccountAssetAddressesPaginated */ readonly after?: string; } /** * Request parameters for getVaultAssets operation in VaultsApi. * @export * @interface VaultsApiGetVaultAssetsRequest */ export interface VaultsApiGetVaultAssetsRequest { /** * * @type {string} * @memberof VaultsApiGetVaultAssets */ readonly accountNamePrefix?: string; /** * * @type {string} * @memberof VaultsApiGetVaultAssets */ readonly accountNameSuffix?: string; } /** * Request parameters for getVaultBalanceByAsset operation in VaultsApi. * @export * @interface VaultsApiGetVaultBalanceByAssetRequest */ export interface VaultsApiGetVaultBalanceByAssetRequest { /** * * @type {string} * @memberof VaultsApiGetVaultBalanceByAsset */ readonly assetId: string; } /** * Request parameters for hideVaultAccount operation in VaultsApi. * @export * @interface VaultsApiHideVaultAccountRequest */ export interface VaultsApiHideVaultAccountRequest { /** * The vault account to hide * @type {string} * @memberof VaultsApiHideVaultAccount */ readonly vaultAccountId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiHideVaultAccount */ readonly idempotencyKey?: string; } /** * Request parameters for lookupVaultByAddress operation in VaultsApi. * @export * @interface VaultsApiLookupVaultByAddressRequest */ export interface VaultsApiLookupVaultByAddressRequest { /** * The blockchain address to resolve. * @type {string} * @memberof VaultsApiLookupVaultByAddress */ readonly address: string; } /** * Request parameters for setCustomerRefIdForAddress operation in VaultsApi. * @export * @interface VaultsApiSetCustomerRefIdForAddressRequest */ export interface VaultsApiSetCustomerRefIdForAddressRequest { /** * * @type {SetCustomerRefIdForAddressRequest} * @memberof VaultsApiSetCustomerRefIdForAddress */ readonly setCustomerRefIdForAddressRequest: SetCustomerRefIdForAddressRequest; /** * The ID of the vault account * @type {string} * @memberof VaultsApiSetCustomerRefIdForAddress */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiSetCustomerRefIdForAddress */ readonly assetId: string; /** * The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address * @type {string} * @memberof VaultsApiSetCustomerRefIdForAddress */ readonly addressId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiSetCustomerRefIdForAddress */ readonly idempotencyKey?: string; } /** * Request parameters for setUsdcGatewayDepositAutomationBeta operation in VaultsApi. * @export * @interface VaultsApiSetUsdcGatewayDepositAutomationBetaRequest */ export interface VaultsApiSetUsdcGatewayDepositAutomationBetaRequest { /** * * @type {AutomationSettingsRequest} * @memberof VaultsApiSetUsdcGatewayDepositAutomationBeta */ readonly automationSettingsRequest: AutomationSettingsRequest; /** * The ID of the vault account * @type {string} * @memberof VaultsApiSetUsdcGatewayDepositAutomationBeta */ readonly vaultAccountId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiSetUsdcGatewayDepositAutomationBeta */ readonly idempotencyKey?: string; } /** * Request parameters for setVaultAccountAutoFuel operation in VaultsApi. * @export * @interface VaultsApiSetVaultAccountAutoFuelRequest */ export interface VaultsApiSetVaultAccountAutoFuelRequest { /** * * @type {SetAutoFuelRequest} * @memberof VaultsApiSetVaultAccountAutoFuel */ readonly setAutoFuelRequest: SetAutoFuelRequest; /** * The vault account ID * @type {string} * @memberof VaultsApiSetVaultAccountAutoFuel */ readonly vaultAccountId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiSetVaultAccountAutoFuel */ readonly idempotencyKey?: string; } /** * Request parameters for setVaultAccountCustomerRefId operation in VaultsApi. * @export * @interface VaultsApiSetVaultAccountCustomerRefIdRequest */ export interface VaultsApiSetVaultAccountCustomerRefIdRequest { /** * * @type {SetCustomerRefIdRequest} * @memberof VaultsApiSetVaultAccountCustomerRefId */ readonly setCustomerRefIdRequest: SetCustomerRefIdRequest; /** * The vault account ID * @type {string} * @memberof VaultsApiSetVaultAccountCustomerRefId */ readonly vaultAccountId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiSetVaultAccountCustomerRefId */ readonly idempotencyKey?: string; } /** * Request parameters for unhideVaultAccount operation in VaultsApi. * @export * @interface VaultsApiUnhideVaultAccountRequest */ export interface VaultsApiUnhideVaultAccountRequest { /** * The vault account to unhide * @type {string} * @memberof VaultsApiUnhideVaultAccount */ readonly vaultAccountId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiUnhideVaultAccount */ readonly idempotencyKey?: string; } /** * Request parameters for updateUsdcGatewayDepositAutomationBeta operation in VaultsApi. * @export * @interface VaultsApiUpdateUsdcGatewayDepositAutomationBetaRequest */ export interface VaultsApiUpdateUsdcGatewayDepositAutomationBetaRequest { /** * * @type {UpdateAutomationSettingsRequest} * @memberof VaultsApiUpdateUsdcGatewayDepositAutomationBeta */ readonly updateAutomationSettingsRequest: UpdateAutomationSettingsRequest; /** * The ID of the vault account * @type {string} * @memberof VaultsApiUpdateUsdcGatewayDepositAutomationBeta */ readonly vaultAccountId: string; /** * The ID of the deposit automation, returned when it was created or read * @type {string} * @memberof VaultsApiUpdateUsdcGatewayDepositAutomationBeta */ readonly automationId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiUpdateUsdcGatewayDepositAutomationBeta */ readonly idempotencyKey?: string; } /** * Request parameters for updateVaultAccount operation in VaultsApi. * @export * @interface VaultsApiUpdateVaultAccountRequest */ export interface VaultsApiUpdateVaultAccountRequest { /** * * @type {UpdateVaultAccountRequest} * @memberof VaultsApiUpdateVaultAccount */ readonly updateVaultAccountRequest: UpdateVaultAccountRequest; /** * The ID of the vault account to edit * @type {string} * @memberof VaultsApiUpdateVaultAccount */ readonly vaultAccountId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiUpdateVaultAccount */ readonly idempotencyKey?: string; } /** * Request parameters for updateVaultAccountAssetAddress operation in VaultsApi. * @export * @interface VaultsApiUpdateVaultAccountAssetAddressRequest */ export interface VaultsApiUpdateVaultAccountAssetAddressRequest { /** * The ID of the vault account * @type {string} * @memberof VaultsApiUpdateVaultAccountAssetAddress */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiUpdateVaultAccountAssetAddress */ readonly assetId: string; /** * The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address * @type {string} * @memberof VaultsApiUpdateVaultAccountAssetAddress */ readonly addressId: string; /** * * @type {UpdateVaultAccountAssetAddressRequest} * @memberof VaultsApiUpdateVaultAccountAssetAddress */ readonly updateVaultAccountAssetAddressRequest?: UpdateVaultAccountAssetAddressRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiUpdateVaultAccountAssetAddress */ readonly idempotencyKey?: string; } /** * Request parameters for updateVaultAccountAssetBalance operation in VaultsApi. * @export * @interface VaultsApiUpdateVaultAccountAssetBalanceRequest */ export interface VaultsApiUpdateVaultAccountAssetBalanceRequest { /** * The ID of the vault account to return * @type {string} * @memberof VaultsApiUpdateVaultAccountAssetBalance */ readonly vaultAccountId: string; /** * The ID of the asset * @type {string} * @memberof VaultsApiUpdateVaultAccountAssetBalance */ readonly assetId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof VaultsApiUpdateVaultAccountAssetBalance */ readonly idempotencyKey?: string; } /** * VaultsApi - object-oriented interface * @export * @class VaultsApi * @extends {BaseAPI} */ export declare class VaultsApi extends BaseAPI { /** * Initiates activation for a wallet in a vault account. Activation is required for tokens that need an on-chain transaction for creation. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Activate a wallet in a vault account * @param {VaultsApiActivateAssetForVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ activateAssetForVaultAccount(requestParameters: VaultsApiActivateAssetForVaultAccountRequest): Promise>; /** * Activates the USDC Gateway wallet associated with the given vault account. If the wallet does not yet exist it is created in an activated state. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Activate a USDC Gateway wallet * @param {VaultsApiActivateUsdcGatewayWalletBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ activateUsdcGatewayWalletBeta(requestParameters: VaultsApiActivateUsdcGatewayWalletBetaRequest): Promise>; /** * Attach or detach one or more tags from the requested vault accounts. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver. * @summary Attach or detach tags from vault accounts * @param {VaultsApiAttachOrDetachTagsFromVaultAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ attachOrDetachTagsFromVaultAccounts(requestParameters: VaultsApiAttachOrDetachTagsFromVaultAccountsRequest): Promise>; /** * Converts an existing segwit address to the legacy format. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Convert a segwit address to legacy format * @param {VaultsApiCreateLegacyAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ createLegacyAddress(requestParameters: VaultsApiCreateLegacyAddressRequest): Promise>; /** * Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. - With `vaultType: KEY_LINK`, creates Key Link vault accounts; set `autoAssign: true` to bind them to the workspace\'s signing keys (see `vaultType` and `autoAssign`). **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Bulk creation of new vault accounts * @param {VaultsApiCreateMultipleAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ createMultipleAccounts(requestParameters: VaultsApiCreateMultipleAccountsRequest): Promise>; /** * **For UTXO blockchains only.** Create multiple deposit addresses by running an async job. - The target Vault account should already have a UTXO asset wallet with a permanent address. - Limited to a maximum of 10,000 addresses per operation. Use multiple operations for the same Vault account/permanent address if needed. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Bulk creation of new deposit addresses * @param {VaultsApiCreateMultipleDepositAddressesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ createMultipleDepositAddresses(requestParameters: VaultsApiCreateMultipleDepositAddressesRequest): Promise>; /** * Creates a new vault account with the requested name. **Note: ** Vault account names should consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Create a new vault account * @param {VaultsApiCreateVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ createVaultAccount(requestParameters: VaultsApiCreateVaultAccountRequest): Promise>; /** * Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Create a new vault wallet * @param {VaultsApiCreateVaultAccountAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ createVaultAccountAsset(requestParameters: VaultsApiCreateVaultAccountAssetRequest): Promise>; /** * Creates a new deposit address for an asset of a vault account. Should be used for UTXO or Tag/Memo based assets ONLY. Requests with account based assets will fail. Endpoint Permission: Admin, Non-Signing Admin. * @summary Create new asset deposit address * @param {VaultsApiCreateVaultAccountAssetAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ createVaultAccountAssetAddress(requestParameters: VaultsApiCreateVaultAccountAssetAddressRequest): Promise>; /** * Deactivates the USDC Gateway wallet associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Deactivate a USDC Gateway wallet * @param {VaultsApiDeactivateUsdcGatewayWalletBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ deactivateUsdcGatewayWalletBeta(requestParameters: VaultsApiDeactivateUsdcGatewayWalletBetaRequest): Promise>; /** * Stops the schedule for an existing deposit automation. The automation itself stays configured, only its schedule stops. Turn it back on later with PATCH, without setting up the automation again from scratch. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Stop a USDC Gateway deposit automation\'s schedule * @param {VaultsApiDisableUsdcGatewayDepositAutomationScheduleBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ disableUsdcGatewayDepositAutomationScheduleBeta(requestParameters: VaultsApiDisableUsdcGatewayDepositAutomationScheduleBetaRequest): Promise>; /** * Get all vault wallets of the vault accounts in your workspace. A vault wallet is an asset in a vault account. This method allows fast traversal of all account balances. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault wallets (Paginated) * @param {VaultsApiGetAssetWalletsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getAssetWallets(requestParameters?: VaultsApiGetAssetWalletsRequest): Promise>; /** * Returns the current status of (or an error for) the specified deposit addresss bulk creation job. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer. * @summary Get the job status of the bulk deposit address creation * @param {VaultsApiGetCreateMultipleDepositAddressesJobStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getCreateMultipleDepositAddressesJobStatus(requestParameters: VaultsApiGetCreateMultipleDepositAddressesJobStatusRequest): Promise>; /** * Returns the current status of (or error for) the specified vault account bulk creation job. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get job status of bulk creation of new vault accounts * @param {VaultsApiGetCreateMultipleVaultAccountsJobStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getCreateMultipleVaultAccountsJobStatus(requestParameters: VaultsApiGetCreateMultipleVaultAccountsJobStatusRequest): Promise>; /** * Retrieves the maximum BIP44 address index and change address index used for a specific asset in a vault account (BIP44 standard). * @summary Get maximum BIP44 index used * @param {VaultsApiGetMaxBipIndexUsedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getMaxBipIndexUsed(requestParameters: VaultsApiGetMaxBipIndexUsedRequest): Promise>; /** * **UTXO assets only.** Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get max spendable amount in a transaction * @param {VaultsApiGetMaxSpendableAmountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getMaxSpendableAmount(requestParameters: VaultsApiGetMaxSpendableAmountRequest): Promise>; /** * Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault accounts (Paginated) * @param {VaultsApiGetPagedVaultAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getPagedVaultAccounts(requestParameters?: VaultsApiGetPagedVaultAccountsRequest): Promise>; /** * Gets the public key information based on derivation path and signing algorithm. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get the public key for a derivation path * @param {VaultsApiGetPublicKeyInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getPublicKeyInfo(requestParameters: VaultsApiGetPublicKeyInfoRequest): Promise>; /** * Get the public key information for a specific asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get an asset\'s public key * @param {VaultsApiGetPublicKeyInfoForAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getPublicKeyInfoForAddress(requestParameters: VaultsApiGetPublicKeyInfoForAddressRequest): Promise>; /** * Returns unspent inputs information of an UTXO asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get UTXO unspent inputs information * @param {VaultsApiGetUnspentInputsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getUnspentInputs(requestParameters: VaultsApiGetUnspentInputsRequest): Promise>; /** * Returns the USDC Gateway deposit automations configured for the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Read the USDC Gateway deposit automations for a vault account * @param {VaultsApiGetUsdcGatewayDepositAutomationBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getUsdcGatewayDepositAutomationBeta(requestParameters: VaultsApiGetUsdcGatewayDepositAutomationBetaRequest): Promise>; /** * Returns the USDC Gateway wallet information associated with the given vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get USDC Gateway wallet info * @param {VaultsApiGetUsdcGatewayWalletInfoBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getUsdcGatewayWalletInfoBeta(requestParameters: VaultsApiGetUsdcGatewayWalletInfoBetaRequest): Promise>; /** * Get a vault account by its unique ID. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get a vault account by ID * @param {VaultsApiGetVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getVaultAccount(requestParameters: VaultsApiGetVaultAccountRequest): Promise>; /** * Returns a specific vault wallet balance information for a specific asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get the asset balance for a vault account * @param {VaultsApiGetVaultAccountAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getVaultAccountAsset(requestParameters: VaultsApiGetVaultAccountAssetRequest): Promise>; /** * Returns a paginated response of the addresses for a given vault account and asset. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get addresses (Paginated) * @param {VaultsApiGetVaultAccountAssetAddressesPaginatedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getVaultAccountAssetAddressesPaginated(requestParameters: VaultsApiGetVaultAccountAssetAddressesPaginatedRequest): Promise>; /** * Gets the assets amount summary for all accounts or filtered accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get asset balance for chosen assets * @param {VaultsApiGetVaultAssetsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getVaultAssets(requestParameters?: VaultsApiGetVaultAssetsRequest): Promise>; /** * Get the total balance of an asset across all the vault accounts. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get vault balance by an asset * @param {VaultsApiGetVaultBalanceByAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ getVaultBalanceByAsset(requestParameters: VaultsApiGetVaultBalanceByAssetRequest): Promise>; /** * Hides the requested vault account from the web console view. This operation is required when creating thousands of vault accounts to serve your end-users. Used for preventing the web console to be swamped with too much vault accounts. Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts). NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Hide a vault account in the console * @param {VaultsApiHideVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ hideVaultAccount(requestParameters: VaultsApiHideVaultAccountRequest): Promise>; /** * Resolves a blockchain address to the vault account that owns it. Returns the vault account ID and the blockchains associated with the address. **Note:** This endpoint is currently in beta and might be subject to changes. * @summary Look up a vault account by blockchain address * @param {VaultsApiLookupVaultByAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ lookupVaultByAddress(requestParameters: VaultsApiLookupVaultByAddressRequest): Promise>; /** * Sets an AML/KYT customer reference ID for a specific address. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign AML customer reference ID * @param {VaultsApiSetCustomerRefIdForAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ setCustomerRefIdForAddress(requestParameters: VaultsApiSetCustomerRefIdForAddressRequest): Promise>; /** * Turns on automatic deposits into the USDC Gateway wallet for the given vault account, on the schedule you choose. Returns an error if an automation already exists for this vault account and asset. Use PATCH to change it instead. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Set up a USDC Gateway deposit automation for a vault account * @param {VaultsApiSetUsdcGatewayDepositAutomationBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ setUsdcGatewayDepositAutomationBeta(requestParameters: VaultsApiSetUsdcGatewayDepositAutomationBetaRequest): Promise>; /** * Toggles the auto fueling property of the vault account to enabled or disabled. Vault Accounts with \'autoFuel=true\' are monitored and auto fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Set auto fueling to on or off * @param {VaultsApiSetVaultAccountAutoFuelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ setVaultAccountAutoFuel(requestParameters: VaultsApiSetVaultAccountAutoFuelRequest): Promise>; /** * Assigns an AML/KYT customer reference ID for the vault account. Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies). Endpoint Permission: Admin, Non-Signing Admin. * @summary Set an AML/KYT ID for a vault account * @param {VaultsApiSetVaultAccountCustomerRefIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ setVaultAccountCustomerRefId(requestParameters: VaultsApiSetVaultAccountCustomerRefIdRequest): Promise>; /** * Makes a hidden vault account visible in web console view. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Unhide a vault account in the console * @param {VaultsApiUnhideVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ unhideVaultAccount(requestParameters: VaultsApiUnhideVaultAccountRequest): Promise>; /** * Changes an existing USDC Gateway deposit automation for a vault account. **Note:** This endpoint is currently in beta and might be subject to changes. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Change a USDC Gateway deposit automation * @param {VaultsApiUpdateUsdcGatewayDepositAutomationBetaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ updateUsdcGatewayDepositAutomationBeta(requestParameters: VaultsApiUpdateUsdcGatewayDepositAutomationBetaRequest): Promise>; /** * Renames the requested vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver. * @summary Rename a vault account * @param {VaultsApiUpdateVaultAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ updateVaultAccount(requestParameters: VaultsApiUpdateVaultAccountRequest): Promise>; /** * Updates the description of an existing address of an asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Update address description * @param {VaultsApiUpdateVaultAccountAssetAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ updateVaultAccountAssetAddress(requestParameters: VaultsApiUpdateVaultAccountAssetAddressRequest): Promise>; /** * Updates the balance of a specific asset in a vault account. This API endpoint is subject to a strict rate limit. Should be used by clients in very specific scenarios. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor. * @summary Refresh asset balance data * @param {VaultsApiUpdateVaultAccountAssetBalanceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VaultsApi */ updateVaultAccountAssetBalance(requestParameters: VaultsApiUpdateVaultAccountAssetBalanceRequest): Promise>; } /** * @export */ export declare const GetAssetWalletsOrderByEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetAssetWalletsOrderByEnum = typeof GetAssetWalletsOrderByEnum[keyof typeof GetAssetWalletsOrderByEnum]; /** * @export */ export declare const GetPagedVaultAccountsOrderByEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetPagedVaultAccountsOrderByEnum = typeof GetPagedVaultAccountsOrderByEnum[keyof typeof GetPagedVaultAccountsOrderByEnum];