Struct VaultsApiClient

pub struct VaultsApiClient { /* private fields */ }

Implementations

impl VaultsApiClient

pub fn new(configuration: Arc<Configuration>) -> Self

Trait Implementations

impl VaultsApi for VaultsApiClient

fn activate_asset_for_vault_account<'life0, 'async_trait>( &'life0 self, params: ActivateAssetForVaultAccountParams, ) -> Pin<Box<dyn Future<Output = Result<CreateVaultAssetResponse, Error<ActivateAssetForVaultAccountError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Initiates activation for a wallet in a vault account. Activation is required for tokens that need an on-chain transaction for creation (XLM tokens, SOL tokens etc).
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn create_legacy_address<'life0, 'async_trait>( &'life0 self, params: CreateLegacyAddressParams, ) -> Pin<Box<dyn Future<Output = Result<CreateAddressResponse, Error<CreateLegacyAddressError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Converts an existing segwit address to the legacy format.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn create_multiple_deposit_addresses<'life0, 'async_trait>( &'life0 self, params: CreateMultipleDepositAddressesParams, ) -> Pin<Box<dyn Future<Output = Result<JobCreated, Error<CreateMultipleDepositAddressesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create multiple deposit address by running an async job.
Note:

• We limit accounts to 10k per operation. - The target Vault Account should already have the asset wallet created, or the deposit addresses will fail. - This endpoint should be used for UTXO blockchains. - This endpoint is currently in Early Availability. Please contact CSM to get access to this endpoint. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn create_vault_account<'life0, 'async_trait>( &'life0 self, params: CreateVaultAccountParams, ) -> Pin<Box<dyn Future<Output = Result<VaultAccount, Error<CreateVaultAccountError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn create_vault_account_asset<'life0, 'async_trait>( &'life0 self, params: CreateVaultAccountAssetParams, ) -> Pin<Box<dyn Future<Output = Result<CreateVaultAssetResponse, Error<CreateVaultAccountAssetError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks Vault Wallets in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn create_vault_account_asset_address<'life0, 'async_trait>( &'life0 self, params: CreateVaultAccountAssetAddressParams, ) -> Pin<Box<dyn Future<Output = Result<CreateAddressResponse, Error<CreateVaultAccountAssetAddressError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn get_asset_wallets<'life0, 'async_trait>( &'life0 self, params: GetAssetWalletsParams, ) -> Pin<Box<dyn Future<Output = Result<PaginatedAssetWalletResponse, Error<GetAssetWalletsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn get_create_multiple_deposit_addresses_job_status<'life0, 'async_trait>( &'life0 self, params: GetCreateMultipleDepositAddressesJobStatusParams, ) -> Pin<Box<dyn Future<Output = Result<CreateMultipleDepositAddressesJobStatus, Error<GetCreateMultipleDepositAddressesJobStatusError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the status of the bulk creation of new deposit addresses job, and the result or error. Note: - The target Vault Account should already have the asset wallet created, or the deposit addresses will fail. - This endpoint is currently in Early Availability. Please contact CSM to get access to this endpoint. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn get_max_spendable_amount<'life0, 'async_trait>( &'life0 self, params: GetMaxSpendableAmountParams, ) -> Pin<Box<dyn Future<Output = Result<GetMaxSpendableAmountResponse, Error<GetMaxSpendableAmountError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the maximum amount of a particular asset that can be spent in a single transaction from a specified vault account (UTXO assets only).
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

fn get_paged_vault_accounts<'life0, 'async_trait>( &'life0 self, params: GetPagedVaultAccountsParams, ) -> Pin<Box<dyn Future<Output = Result<VaultAccountsPagedResponse, Error<GetPagedVaultAccountsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn get_public_key_info<'life0, 'async_trait>( &'life0 self, params: GetPublicKeyInfoParams, ) -> Pin<Box<dyn Future<Output = Result<PublicKeyInformation, Error<GetPublicKeyInfoError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the public key information based on derivation path and signing algorithm.
Endpoint Permission: Admin, Non-Signing Admin.

fn get_public_key_info_for_address<'life0, 'async_trait>( &'life0 self, params: GetPublicKeyInfoForAddressParams, ) -> Pin<Box<dyn Future<Output = Result<PublicKeyInformation, Error<GetPublicKeyInfoForAddressError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the public key information for a specific asset in a vault account.
Endpoint Permission: Admin, Non-Signing Admin.

fn get_unspent_inputs<'life0, 'async_trait>( &'life0 self, params: GetUnspentInputsParams, ) -> Pin<Box<dyn Future<Output = Result<Vec<UnspentInputsResponse>, Error<GetUnspentInputsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns unspent inputs information of an UTXO asset in a vault account.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

fn get_vault_account<'life0, 'async_trait>( &'life0 self, params: GetVaultAccountParams, ) -> Pin<Box<dyn Future<Output = Result<VaultAccount, Error<GetVaultAccountError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a vault account by its unique ID.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

fn get_vault_account_asset<'life0, 'async_trait>( &'life0 self, params: GetVaultAccountAssetParams, ) -> Pin<Box<dyn Future<Output = Result<VaultAsset, Error<GetVaultAccountAssetError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a specific vault wallet balance information for a specific asset.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

fn get_vault_account_asset_addresses<'life0, 'async_trait>( &'life0 self, params: GetVaultAccountAssetAddressesParams, ) -> Pin<Box<dyn Future<Output = Result<Vec<VaultWalletAddress>, Error<GetVaultAccountAssetAddressesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

DEPRECATED! - If your application logic or scripts rely on the deprecated endpoint, you should update to account for GET/V1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated before Mar 31,2024. - All workspaces created after Mar 31,2024. will have it disabled. If it is disabled for your workspace and you attempt to use it, you will receive the following error message: "This endpoint is unavailable. - Please use the GET /v1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated endpoint to return all the wallet addresses associated with the specified vault account and asset in a paginated list.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

fn get_vault_account_asset_addresses_paginated<'life0, 'async_trait>( &'life0 self, params: GetVaultAccountAssetAddressesPaginatedParams, ) -> Pin<Box<dyn Future<Output = Result<PaginatedAddressResponse, Error<GetVaultAccountAssetAddressesPaginatedError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a paginated response of the addresses for a given vault account and asset.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

fn get_vault_assets<'life0, 'async_trait>( &'life0 self, params: GetVaultAssetsParams, ) -> Pin<Box<dyn Future<Output = Result<Vec<VaultAsset>, Error<GetVaultAssetsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the assets amount summary for all accounts or filtered accounts.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

fn get_vault_balance_by_asset<'life0, 'async_trait>( &'life0 self, params: GetVaultBalanceByAssetParams, ) -> Pin<Box<dyn Future<Output = Result<VaultAsset, Error<GetVaultBalanceByAssetError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the total balance of an asset across all the vault accounts.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

fn hide_vault_account<'life0, 'async_trait>( &'life0 self, params: HideVaultAccountParams, ) -> Pin<Box<dyn Future<Output = Result<VaultActionStatus, Error<HideVaultAccountError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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. 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.

fn set_customer_ref_id_for_address<'life0, 'async_trait>( &'life0 self, params: SetCustomerRefIdForAddressParams, ) -> Pin<Box<dyn Future<Output = Result<VaultActionStatus, Error<SetCustomerRefIdForAddressError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets an AML/KYT customer reference ID for a specific address.
Endpoint Permission: Admin, Non-Signing Admin.

fn set_vault_account_auto_fuel<'life0, 'async_trait>( &'life0 self, params: SetVaultAccountAutoFuelParams, ) -> Pin<Box<dyn Future<Output = Result<VaultActionStatus, Error<SetVaultAccountAutoFuelError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn set_vault_account_customer_ref_id<'life0, 'async_trait>( &'life0 self, params: SetVaultAccountCustomerRefIdParams, ) -> Pin<Box<dyn Future<Output = Result<VaultActionStatus, Error<SetVaultAccountCustomerRefIdError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Assigns an AML/KYT customer reference ID for the vault account. Learn more about Fireblocks AML management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin.

fn unhide_vault_account<'life0, 'async_trait>( &'life0 self, params: UnhideVaultAccountParams, ) -> Pin<Box<dyn Future<Output = Result<VaultActionStatus, Error<UnhideVaultAccountError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Makes a hidden vault account visible in web console view.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn update_vault_account<'life0, 'async_trait>( &'life0 self, params: UpdateVaultAccountParams, ) -> Pin<Box<dyn Future<Output = Result<RenameVaultAccountResponse, Error<UpdateVaultAccountError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Renames the requested vault account.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver.

fn update_vault_account_asset_address<'life0, 'async_trait>( &'life0 self, params: UpdateVaultAccountAssetAddressParams, ) -> Pin<Box<dyn Future<Output = Result<VaultActionStatus, Error<UpdateVaultAccountAssetAddressError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates the description of an existing address of an asset in a vault account.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

fn update_vault_account_asset_balance<'life0, 'async_trait>( &'life0 self, params: UpdateVaultAccountAssetBalanceParams, ) -> Pin<Box<dyn Future<Output = Result<VaultAsset, Error<UpdateVaultAccountAssetBalanceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.