/** * 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 { AddConnectedAccountRequest } from '../models'; import { AddConnectedAccountResponse } from '../models'; import { AllowlistEntryResponse } from '../models'; import { AllowlistEntryStatus } from '../models'; import { AllowlistResponse } from '../models'; import { ConnectedAccountBalancesResponse } from '../models'; import { ConnectedAccountRateResponse } from '../models'; import { ConnectedAccountTradingPairsResponse } from '../models'; import { ConnectedAccountsResponse } from '../models'; import { ConnectedSingleAccountResponse } from '../models'; import { GetConnectedAccountsCredentialsPublicKeyResponse } from '../models'; import { RenameConnectedAccountRequest } from '../models'; import { RenameConnectedAccountResponse } from '../models'; import { UpdateConnectedAccountCredentialsRequest } from '../models'; import { UpdateConnectedAccountCredentialsResponse } from '../models'; /** * ConnectedAccountsApi - axios parameter creator * @export */ export declare const ConnectedAccountsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new connected account for the authenticated tenant. The `creds` field must be a Base64-encoded RSA-encrypted credential blob. Use `GET /connected_accounts/credentials/public_key` to retrieve the public key for encryption. The `providerType` is derived server-side from the `providerId` — callers do not supply it. Endpoint Permission: Editor, Admin, Non-Signing Admin. * @summary Add a connected account * @param {AddConnectedAccountRequest} addConnectedAccountRequest * @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} */ addConnectedAccount: (addConnectedAccountRequest: AddConnectedAccountRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Disconnect a connected account by ID. * @summary Disconnect connected account * @param {string} accountId The ID of the account to disconnect. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disconnectConnectedAccount: (accountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve detailed information about a specific connected account by ID. * @summary Get connected account * @param {string} accountId The ID of the account to fetch. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccount: (accountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the address allowlist for a specified connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Get allowlist for connected account * @param {string} accountId The connected account identifier * @param {AllowlistEntryStatus} [status] Filter by allowlist entry status * @param {string} [assetId] Filter by Fireblocks asset ID. See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. * @param {string} [networkId] Filter by Fireblocks network ID. See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. * @param {string} [address] Filter by specific address * @param {string} [pageCursor] Pagination cursor for next page * @param {number} [pageSize] Maximum number of entries to return * @param {GetConnectedAccountAllowlistOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountAllowlist: (accountId: string, status?: AllowlistEntryStatus, assetId?: string, networkId?: string, address?: string, pageCursor?: string, pageSize?: number, order?: GetConnectedAccountAllowlistOrderEnum, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Get a single allowlist entry for a connected account * @param {string} accountId The connected account identifier * @param {string} allowlistId The Fireblocks allowlist entry identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountAllowlistEntry: (accountId: string, allowlistId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`). * @summary Get balances for an account * @param {string} accountId The ID of the account to fetch balances for. * @param {number} [pageSize] Page size for pagination. * @param {string} [pageCursor] Page cursor for pagination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountBalances: (accountId: string, pageSize?: number, pageCursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve current exchange rates for converting between specific assets in a connected account. * @summary Get exchange rates for an account * @param {string} accountId The ID of the account to fetch rates for. * @param {string} baseAssetId The ID of the asset to fetch rates for. * @param {string} quoteAssetId The ID of the asset to get the rates nominally. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountRates: (accountId: string, baseAssetId: string, quoteAssetId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve all asset trading pairs supported by a specific connected account, including the pair type (`quote`, `market`, `onOffRamp`). * @summary Get supported trading pairs for an account * @param {string} accountId The ID of the account to fetch supported pairs for. * @param {number} [pageSize] Page size for pagination. * @param {string} [pageCursor] Page cursor for pagination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountTradingPairs: (accountId: string, pageSize?: number, pageCursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns all connected accounts. * @summary Get connected accounts * @param {boolean} [mainAccounts] Whether to include only main accounts in the response. * @param {number} [pageSize] Page size for pagination. * @param {string} [pageCursor] Page cursor for pagination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccounts: (mainAccounts?: boolean, pageSize?: number, pageCursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the RSA public key used to encrypt the `creds` field before calling `POST /connected_accounts`. The key is a singleton resource scoped to the connected-accounts credentials domain — there is one per tenant context. * @summary Get public key to encrypt connected account credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountsCredentialsPublicKey: (options?: RawAxiosRequestConfig) => Promise; /** * Rename a connected account by account ID. * @summary Rename Connected Account * @param {RenameConnectedAccountRequest} renameConnectedAccountRequest * @param {string} accountId The unique identifier of the connected 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} */ renameConnectedAccount: (renameConnectedAccountRequest: RenameConnectedAccountRequest, accountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Sync allowlist for connected account * @param {string} accountId The connected account identifier * @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} */ syncConnectedAccountAllowlist: (accountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Replace the API credentials (secret + API key) of a connected account. Credentials belong to an API key, which can back a single account or an entire hierarchy. Updating them affects all accounts sharing that key, so the endpoint returns an array of modified accounts. The `creds` field must be a Base64-encoded RSA-encrypted credential blob; use `GET /connected_accounts/credentials/public_key` to retrieve the public key for encryption. Both `creds` and `apiKey` are mandatory. Validation against the exchange is synchronous, but the update itself is **pending mobile approval** — the existing credentials stay live until the change is approved, so none of the affected accounts are disconnected in the meantime. Endpoint Permission: Admin, Non-Signing Admin. * @summary Update connected account credentials * @param {UpdateConnectedAccountCredentialsRequest} updateConnectedAccountCredentialsRequest * @param {string} accountId The unique identifier of the connected account whose API key credentials are being replaced. * @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} */ updateConnectedAccountCredentials: (updateConnectedAccountCredentialsRequest: UpdateConnectedAccountCredentialsRequest, accountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ConnectedAccountsApi - functional programming interface * @export */ export declare const ConnectedAccountsApiFp: (configuration?: Configuration) => { /** * Creates a new connected account for the authenticated tenant. The `creds` field must be a Base64-encoded RSA-encrypted credential blob. Use `GET /connected_accounts/credentials/public_key` to retrieve the public key for encryption. The `providerType` is derived server-side from the `providerId` — callers do not supply it. Endpoint Permission: Editor, Admin, Non-Signing Admin. * @summary Add a connected account * @param {AddConnectedAccountRequest} addConnectedAccountRequest * @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} */ addConnectedAccount(addConnectedAccountRequest: AddConnectedAccountRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Disconnect a connected account by ID. * @summary Disconnect connected account * @param {string} accountId The ID of the account to disconnect. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disconnectConnectedAccount(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve detailed information about a specific connected account by ID. * @summary Get connected account * @param {string} accountId The ID of the account to fetch. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccount(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the address allowlist for a specified connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Get allowlist for connected account * @param {string} accountId The connected account identifier * @param {AllowlistEntryStatus} [status] Filter by allowlist entry status * @param {string} [assetId] Filter by Fireblocks asset ID. See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. * @param {string} [networkId] Filter by Fireblocks network ID. See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. * @param {string} [address] Filter by specific address * @param {string} [pageCursor] Pagination cursor for next page * @param {number} [pageSize] Maximum number of entries to return * @param {GetConnectedAccountAllowlistOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountAllowlist(accountId: string, status?: AllowlistEntryStatus, assetId?: string, networkId?: string, address?: string, pageCursor?: string, pageSize?: number, order?: GetConnectedAccountAllowlistOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Get a single allowlist entry for a connected account * @param {string} accountId The connected account identifier * @param {string} allowlistId The Fireblocks allowlist entry identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountAllowlistEntry(accountId: string, allowlistId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`). * @summary Get balances for an account * @param {string} accountId The ID of the account to fetch balances for. * @param {number} [pageSize] Page size for pagination. * @param {string} [pageCursor] Page cursor for pagination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountBalances(accountId: string, pageSize?: number, pageCursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve current exchange rates for converting between specific assets in a connected account. * @summary Get exchange rates for an account * @param {string} accountId The ID of the account to fetch rates for. * @param {string} baseAssetId The ID of the asset to fetch rates for. * @param {string} quoteAssetId The ID of the asset to get the rates nominally. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountRates(accountId: string, baseAssetId: string, quoteAssetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve all asset trading pairs supported by a specific connected account, including the pair type (`quote`, `market`, `onOffRamp`). * @summary Get supported trading pairs for an account * @param {string} accountId The ID of the account to fetch supported pairs for. * @param {number} [pageSize] Page size for pagination. * @param {string} [pageCursor] Page cursor for pagination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountTradingPairs(accountId: string, pageSize?: number, pageCursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns all connected accounts. * @summary Get connected accounts * @param {boolean} [mainAccounts] Whether to include only main accounts in the response. * @param {number} [pageSize] Page size for pagination. * @param {string} [pageCursor] Page cursor for pagination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccounts(mainAccounts?: boolean, pageSize?: number, pageCursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the RSA public key used to encrypt the `creds` field before calling `POST /connected_accounts`. The key is a singleton resource scoped to the connected-accounts credentials domain — there is one per tenant context. * @summary Get public key to encrypt connected account credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountsCredentialsPublicKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Rename a connected account by account ID. * @summary Rename Connected Account * @param {RenameConnectedAccountRequest} renameConnectedAccountRequest * @param {string} accountId The unique identifier of the connected 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} */ renameConnectedAccount(renameConnectedAccountRequest: RenameConnectedAccountRequest, accountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Sync allowlist for connected account * @param {string} accountId The connected account identifier * @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} */ syncConnectedAccountAllowlist(accountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Replace the API credentials (secret + API key) of a connected account. Credentials belong to an API key, which can back a single account or an entire hierarchy. Updating them affects all accounts sharing that key, so the endpoint returns an array of modified accounts. The `creds` field must be a Base64-encoded RSA-encrypted credential blob; use `GET /connected_accounts/credentials/public_key` to retrieve the public key for encryption. Both `creds` and `apiKey` are mandatory. Validation against the exchange is synchronous, but the update itself is **pending mobile approval** — the existing credentials stay live until the change is approved, so none of the affected accounts are disconnected in the meantime. Endpoint Permission: Admin, Non-Signing Admin. * @summary Update connected account credentials * @param {UpdateConnectedAccountCredentialsRequest} updateConnectedAccountCredentialsRequest * @param {string} accountId The unique identifier of the connected account whose API key credentials are being replaced. * @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} */ updateConnectedAccountCredentials(updateConnectedAccountCredentialsRequest: UpdateConnectedAccountCredentialsRequest, accountId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ConnectedAccountsApi - factory interface * @export */ export declare const ConnectedAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new connected account for the authenticated tenant. The `creds` field must be a Base64-encoded RSA-encrypted credential blob. Use `GET /connected_accounts/credentials/public_key` to retrieve the public key for encryption. The `providerType` is derived server-side from the `providerId` — callers do not supply it. Endpoint Permission: Editor, Admin, Non-Signing Admin. * @summary Add a connected account * @param {ConnectedAccountsApiAddConnectedAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addConnectedAccount(requestParameters: ConnectedAccountsApiAddConnectedAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Disconnect a connected account by ID. * @summary Disconnect connected account * @param {ConnectedAccountsApiDisconnectConnectedAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disconnectConnectedAccount(requestParameters: ConnectedAccountsApiDisconnectConnectedAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve detailed information about a specific connected account by ID. * @summary Get connected account * @param {ConnectedAccountsApiGetConnectedAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccount(requestParameters: ConnectedAccountsApiGetConnectedAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the address allowlist for a specified connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Get allowlist for connected account * @param {ConnectedAccountsApiGetConnectedAccountAllowlistRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountAllowlist(requestParameters: ConnectedAccountsApiGetConnectedAccountAllowlistRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Get a single allowlist entry for a connected account * @param {ConnectedAccountsApiGetConnectedAccountAllowlistEntryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountAllowlistEntry(requestParameters: ConnectedAccountsApiGetConnectedAccountAllowlistEntryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`). * @summary Get balances for an account * @param {ConnectedAccountsApiGetConnectedAccountBalancesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountBalances(requestParameters: ConnectedAccountsApiGetConnectedAccountBalancesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve current exchange rates for converting between specific assets in a connected account. * @summary Get exchange rates for an account * @param {ConnectedAccountsApiGetConnectedAccountRatesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountRates(requestParameters: ConnectedAccountsApiGetConnectedAccountRatesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve all asset trading pairs supported by a specific connected account, including the pair type (`quote`, `market`, `onOffRamp`). * @summary Get supported trading pairs for an account * @param {ConnectedAccountsApiGetConnectedAccountTradingPairsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountTradingPairs(requestParameters: ConnectedAccountsApiGetConnectedAccountTradingPairsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns all connected accounts. * @summary Get connected accounts * @param {ConnectedAccountsApiGetConnectedAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccounts(requestParameters?: ConnectedAccountsApiGetConnectedAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the RSA public key used to encrypt the `creds` field before calling `POST /connected_accounts`. The key is a singleton resource scoped to the connected-accounts credentials domain — there is one per tenant context. * @summary Get public key to encrypt connected account credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedAccountsCredentialsPublicKey(options?: RawAxiosRequestConfig): AxiosPromise; /** * Rename a connected account by account ID. * @summary Rename Connected Account * @param {ConnectedAccountsApiRenameConnectedAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ renameConnectedAccount(requestParameters: ConnectedAccountsApiRenameConnectedAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Sync allowlist for connected account * @param {ConnectedAccountsApiSyncConnectedAccountAllowlistRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ syncConnectedAccountAllowlist(requestParameters: ConnectedAccountsApiSyncConnectedAccountAllowlistRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Replace the API credentials (secret + API key) of a connected account. Credentials belong to an API key, which can back a single account or an entire hierarchy. Updating them affects all accounts sharing that key, so the endpoint returns an array of modified accounts. The `creds` field must be a Base64-encoded RSA-encrypted credential blob; use `GET /connected_accounts/credentials/public_key` to retrieve the public key for encryption. Both `creds` and `apiKey` are mandatory. Validation against the exchange is synchronous, but the update itself is **pending mobile approval** — the existing credentials stay live until the change is approved, so none of the affected accounts are disconnected in the meantime. Endpoint Permission: Admin, Non-Signing Admin. * @summary Update connected account credentials * @param {ConnectedAccountsApiUpdateConnectedAccountCredentialsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConnectedAccountCredentials(requestParameters: ConnectedAccountsApiUpdateConnectedAccountCredentialsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for addConnectedAccount operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiAddConnectedAccountRequest */ export interface ConnectedAccountsApiAddConnectedAccountRequest { /** * * @type {AddConnectedAccountRequest} * @memberof ConnectedAccountsApiAddConnectedAccount */ readonly addConnectedAccountRequest: AddConnectedAccountRequest; /** * 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 ConnectedAccountsApiAddConnectedAccount */ readonly idempotencyKey?: string; } /** * Request parameters for disconnectConnectedAccount operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiDisconnectConnectedAccountRequest */ export interface ConnectedAccountsApiDisconnectConnectedAccountRequest { /** * The ID of the account to disconnect. * @type {string} * @memberof ConnectedAccountsApiDisconnectConnectedAccount */ readonly accountId: string; } /** * Request parameters for getConnectedAccount operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiGetConnectedAccountRequest */ export interface ConnectedAccountsApiGetConnectedAccountRequest { /** * The ID of the account to fetch. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccount */ readonly accountId: string; } /** * Request parameters for getConnectedAccountAllowlist operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiGetConnectedAccountAllowlistRequest */ export interface ConnectedAccountsApiGetConnectedAccountAllowlistRequest { /** * The connected account identifier * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlist */ readonly accountId: string; /** * Filter by allowlist entry status * @type {AllowlistEntryStatus} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlist */ readonly status?: AllowlistEntryStatus; /** * Filter by Fireblocks asset ID. See [List assets](https://developers.fireblocks.com/reference/listassets) for the canonical list of Fireblocks asset IDs. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlist */ readonly assetId?: string; /** * Filter by Fireblocks network ID. See [List blockchains](https://developers.fireblocks.com/reference/listblockchains) for the canonical list of Fireblocks blockchain identifiers. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlist */ readonly networkId?: string; /** * Filter by specific address * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlist */ readonly address?: string; /** * Pagination cursor for next page * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlist */ readonly pageCursor?: string; /** * Maximum number of entries to return * @type {number} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlist */ readonly pageSize?: number; /** * Sort order (ASC or DESC). * @type {'ASC' | 'DESC'} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlist */ readonly order?: GetConnectedAccountAllowlistOrderEnum; } /** * Request parameters for getConnectedAccountAllowlistEntry operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiGetConnectedAccountAllowlistEntryRequest */ export interface ConnectedAccountsApiGetConnectedAccountAllowlistEntryRequest { /** * The connected account identifier * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlistEntry */ readonly accountId: string; /** * The Fireblocks allowlist entry identifier * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountAllowlistEntry */ readonly allowlistId: string; } /** * Request parameters for getConnectedAccountBalances operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiGetConnectedAccountBalancesRequest */ export interface ConnectedAccountsApiGetConnectedAccountBalancesRequest { /** * The ID of the account to fetch balances for. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountBalances */ readonly accountId: string; /** * Page size for pagination. * @type {number} * @memberof ConnectedAccountsApiGetConnectedAccountBalances */ readonly pageSize?: number; /** * Page cursor for pagination. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountBalances */ readonly pageCursor?: string; } /** * Request parameters for getConnectedAccountRates operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiGetConnectedAccountRatesRequest */ export interface ConnectedAccountsApiGetConnectedAccountRatesRequest { /** * The ID of the account to fetch rates for. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountRates */ readonly accountId: string; /** * The ID of the asset to fetch rates for. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountRates */ readonly baseAssetId: string; /** * The ID of the asset to get the rates nominally. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountRates */ readonly quoteAssetId: string; } /** * Request parameters for getConnectedAccountTradingPairs operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiGetConnectedAccountTradingPairsRequest */ export interface ConnectedAccountsApiGetConnectedAccountTradingPairsRequest { /** * The ID of the account to fetch supported pairs for. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountTradingPairs */ readonly accountId: string; /** * Page size for pagination. * @type {number} * @memberof ConnectedAccountsApiGetConnectedAccountTradingPairs */ readonly pageSize?: number; /** * Page cursor for pagination. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccountTradingPairs */ readonly pageCursor?: string; } /** * Request parameters for getConnectedAccounts operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiGetConnectedAccountsRequest */ export interface ConnectedAccountsApiGetConnectedAccountsRequest { /** * Whether to include only main accounts in the response. * @type {boolean} * @memberof ConnectedAccountsApiGetConnectedAccounts */ readonly mainAccounts?: boolean; /** * Page size for pagination. * @type {number} * @memberof ConnectedAccountsApiGetConnectedAccounts */ readonly pageSize?: number; /** * Page cursor for pagination. * @type {string} * @memberof ConnectedAccountsApiGetConnectedAccounts */ readonly pageCursor?: string; } /** * Request parameters for renameConnectedAccount operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiRenameConnectedAccountRequest */ export interface ConnectedAccountsApiRenameConnectedAccountRequest { /** * * @type {RenameConnectedAccountRequest} * @memberof ConnectedAccountsApiRenameConnectedAccount */ readonly renameConnectedAccountRequest: RenameConnectedAccountRequest; /** * The unique identifier of the connected account * @type {string} * @memberof ConnectedAccountsApiRenameConnectedAccount */ readonly accountId: 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 ConnectedAccountsApiRenameConnectedAccount */ readonly idempotencyKey?: string; } /** * Request parameters for syncConnectedAccountAllowlist operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiSyncConnectedAccountAllowlistRequest */ export interface ConnectedAccountsApiSyncConnectedAccountAllowlistRequest { /** * The connected account identifier * @type {string} * @memberof ConnectedAccountsApiSyncConnectedAccountAllowlist */ readonly accountId: 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 ConnectedAccountsApiSyncConnectedAccountAllowlist */ readonly idempotencyKey?: string; } /** * Request parameters for updateConnectedAccountCredentials operation in ConnectedAccountsApi. * @export * @interface ConnectedAccountsApiUpdateConnectedAccountCredentialsRequest */ export interface ConnectedAccountsApiUpdateConnectedAccountCredentialsRequest { /** * * @type {UpdateConnectedAccountCredentialsRequest} * @memberof ConnectedAccountsApiUpdateConnectedAccountCredentials */ readonly updateConnectedAccountCredentialsRequest: UpdateConnectedAccountCredentialsRequest; /** * The unique identifier of the connected account whose API key credentials are being replaced. * @type {string} * @memberof ConnectedAccountsApiUpdateConnectedAccountCredentials */ readonly accountId: 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 ConnectedAccountsApiUpdateConnectedAccountCredentials */ readonly idempotencyKey?: string; } /** * ConnectedAccountsApi - object-oriented interface * @export * @class ConnectedAccountsApi * @extends {BaseAPI} */ export declare class ConnectedAccountsApi extends BaseAPI { /** * Creates a new connected account for the authenticated tenant. The `creds` field must be a Base64-encoded RSA-encrypted credential blob. Use `GET /connected_accounts/credentials/public_key` to retrieve the public key for encryption. The `providerType` is derived server-side from the `providerId` — callers do not supply it. Endpoint Permission: Editor, Admin, Non-Signing Admin. * @summary Add a connected account * @param {ConnectedAccountsApiAddConnectedAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ addConnectedAccount(requestParameters: ConnectedAccountsApiAddConnectedAccountRequest): Promise>; /** * Disconnect a connected account by ID. * @summary Disconnect connected account * @param {ConnectedAccountsApiDisconnectConnectedAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ disconnectConnectedAccount(requestParameters: ConnectedAccountsApiDisconnectConnectedAccountRequest): Promise>; /** * Retrieve detailed information about a specific connected account by ID. * @summary Get connected account * @param {ConnectedAccountsApiGetConnectedAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ getConnectedAccount(requestParameters: ConnectedAccountsApiGetConnectedAccountRequest): Promise>; /** * Retrieves the address allowlist for a specified connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Get allowlist for connected account * @param {ConnectedAccountsApiGetConnectedAccountAllowlistRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ getConnectedAccountAllowlist(requestParameters: ConnectedAccountsApiGetConnectedAccountAllowlistRequest): Promise>; /** * Retrieves a single allowlist entry by its Fireblocks identifier for a specified connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Get a single allowlist entry for a connected account * @param {ConnectedAccountsApiGetConnectedAccountAllowlistEntryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ getConnectedAccountAllowlistEntry(requestParameters: ConnectedAccountsApiGetConnectedAccountAllowlistEntryRequest): Promise>; /** * Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`). * @summary Get balances for an account * @param {ConnectedAccountsApiGetConnectedAccountBalancesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ getConnectedAccountBalances(requestParameters: ConnectedAccountsApiGetConnectedAccountBalancesRequest): Promise>; /** * Retrieve current exchange rates for converting between specific assets in a connected account. * @summary Get exchange rates for an account * @param {ConnectedAccountsApiGetConnectedAccountRatesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ getConnectedAccountRates(requestParameters: ConnectedAccountsApiGetConnectedAccountRatesRequest): Promise>; /** * Retrieve all asset trading pairs supported by a specific connected account, including the pair type (`quote`, `market`, `onOffRamp`). * @summary Get supported trading pairs for an account * @param {ConnectedAccountsApiGetConnectedAccountTradingPairsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ getConnectedAccountTradingPairs(requestParameters: ConnectedAccountsApiGetConnectedAccountTradingPairsRequest): Promise>; /** * Returns all connected accounts. * @summary Get connected accounts * @param {ConnectedAccountsApiGetConnectedAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ getConnectedAccounts(requestParameters?: ConnectedAccountsApiGetConnectedAccountsRequest): Promise>; /** * Returns the RSA public key used to encrypt the `creds` field before calling `POST /connected_accounts`. The key is a singleton resource scoped to the connected-accounts credentials domain — there is one per tenant context. * @summary Get public key to encrypt connected account credentials * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ getConnectedAccountsCredentialsPublicKey(): Promise>; /** * Rename a connected account by account ID. * @summary Rename Connected Account * @param {ConnectedAccountsApiRenameConnectedAccountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ renameConnectedAccount(requestParameters: ConnectedAccountsApiRenameConnectedAccountRequest): Promise>; /** * Triggers an on-demand sync from the exchange, bypassing the cache and fetching live data immediately. **Rate limit:** 1 request per minute per connected account. **Note:** Currently supports CoinbaseExchange/Binance accounts only. * @summary Sync allowlist for connected account * @param {ConnectedAccountsApiSyncConnectedAccountAllowlistRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ syncConnectedAccountAllowlist(requestParameters: ConnectedAccountsApiSyncConnectedAccountAllowlistRequest): Promise>; /** * Replace the API credentials (secret + API key) of a connected account. Credentials belong to an API key, which can back a single account or an entire hierarchy. Updating them affects all accounts sharing that key, so the endpoint returns an array of modified accounts. The `creds` field must be a Base64-encoded RSA-encrypted credential blob; use `GET /connected_accounts/credentials/public_key` to retrieve the public key for encryption. Both `creds` and `apiKey` are mandatory. Validation against the exchange is synchronous, but the update itself is **pending mobile approval** — the existing credentials stay live until the change is approved, so none of the affected accounts are disconnected in the meantime. Endpoint Permission: Admin, Non-Signing Admin. * @summary Update connected account credentials * @param {ConnectedAccountsApiUpdateConnectedAccountCredentialsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedAccountsApi */ updateConnectedAccountCredentials(requestParameters: ConnectedAccountsApiUpdateConnectedAccountCredentialsRequest): Promise>; } /** * @export */ export declare const GetConnectedAccountAllowlistOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetConnectedAccountAllowlistOrderEnum = typeof GetConnectedAccountAllowlistOrderEnum[keyof typeof GetConnectedAccountAllowlistOrderEnum];