/** * 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 { CreateInternalWalletAssetRequest } from '../models'; import { CreateWalletRequest } from '../models'; import { GetInternalWalletsResponse } from '../models'; import { PaginatedAssetsResponse } from '../models'; import { SetCustomerRefIdRequest } from '../models'; import { UnmanagedWallet } from '../models'; import { WalletAsset } from '../models'; /** * InternalWalletsApi - axios parameter creator * @export */ export declare const InternalWalletsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new internal wallet with the requested name. Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets) * @summary Create an internal wallet * @param {CreateWalletRequest} [createWalletRequest] * @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} */ createInternalWallet: (createWalletRequest?: CreateWalletRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Adds an asset to an existing internal wallet. * @summary Add an asset to an internal wallet * @param {string} walletId The ID of the wallet * @param {string} assetId The ID of the asset to add * @param {CreateInternalWalletAssetRequest} [createInternalWalletAssetRequest] * @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} */ createInternalWalletAsset: (walletId: string, assetId: string, createInternalWalletAssetRequest?: CreateInternalWalletAssetRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes an internal wallet by ID. * @summary Delete an internal wallet * @param {string} walletId The ID of the wallet to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInternalWallet: (walletId: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a whitelisted address (for an asset) from an internal wallet. * @summary Delete a whitelisted address * @param {string} walletId The ID of the wallet * @param {string} assetId The ID of the asset to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInternalWalletAsset: (walletId: string, assetId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns information for an internal wallet. * @summary Get assets for internal wallet * @param {string} walletId The ID of the wallet to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWallet: (walletId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns information for an asset in an internal wallet. * @summary Get an asset from an internal wallet * @param {string} walletId The ID of the wallet * @param {string} assetId The ID of the asset to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWalletAsset: (walletId: string, assetId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated response of assets in an internal wallet. * @summary List assets in an internal wallet (Paginated) * @param {string} walletId The ID of the internal wallet to return assets for * @param {number} [pageSize] * @param {string} [pageCursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWalletAssetsPaginated: (walletId: string, pageSize?: number, pageCursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Gets a list of internal wallets. * @summary List internal wallets * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWallets: (options?: RawAxiosRequestConfig) => Promise; /** * Sets an AML/KYT customer reference ID for the specific internal wallet. * @summary Set an AML/KYT customer reference ID for internal wallet * @param {SetCustomerRefIdRequest} setCustomerRefIdRequest * @param {string} walletId The wallet 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} */ setCustomerRefIdForInternalWallet: (setCustomerRefIdRequest: SetCustomerRefIdRequest, walletId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * InternalWalletsApi - functional programming interface * @export */ export declare const InternalWalletsApiFp: (configuration?: Configuration) => { /** * Creates a new internal wallet with the requested name. Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets) * @summary Create an internal wallet * @param {CreateWalletRequest} [createWalletRequest] * @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} */ createInternalWallet(createWalletRequest?: CreateWalletRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adds an asset to an existing internal wallet. * @summary Add an asset to an internal wallet * @param {string} walletId The ID of the wallet * @param {string} assetId The ID of the asset to add * @param {CreateInternalWalletAssetRequest} [createInternalWalletAssetRequest] * @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} */ createInternalWalletAsset(walletId: string, assetId: string, createInternalWalletAssetRequest?: CreateInternalWalletAssetRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes an internal wallet by ID. * @summary Delete an internal wallet * @param {string} walletId The ID of the wallet to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInternalWallet(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a whitelisted address (for an asset) from an internal wallet. * @summary Delete a whitelisted address * @param {string} walletId The ID of the wallet * @param {string} assetId The ID of the asset to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInternalWalletAsset(walletId: string, assetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information for an internal wallet. * @summary Get assets for internal wallet * @param {string} walletId The ID of the wallet to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWallet(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information for an asset in an internal wallet. * @summary Get an asset from an internal wallet * @param {string} walletId The ID of the wallet * @param {string} assetId The ID of the asset to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWalletAsset(walletId: string, assetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated response of assets in an internal wallet. * @summary List assets in an internal wallet (Paginated) * @param {string} walletId The ID of the internal wallet to return assets for * @param {number} [pageSize] * @param {string} [pageCursor] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWalletAssetsPaginated(walletId: string, pageSize?: number, pageCursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of internal wallets. * @summary List internal wallets * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWallets(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets an AML/KYT customer reference ID for the specific internal wallet. * @summary Set an AML/KYT customer reference ID for internal wallet * @param {SetCustomerRefIdRequest} setCustomerRefIdRequest * @param {string} walletId The wallet 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} */ setCustomerRefIdForInternalWallet(setCustomerRefIdRequest: SetCustomerRefIdRequest, walletId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InternalWalletsApi - factory interface * @export */ export declare const InternalWalletsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new internal wallet with the requested name. Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets) * @summary Create an internal wallet * @param {InternalWalletsApiCreateInternalWalletRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInternalWallet(requestParameters?: InternalWalletsApiCreateInternalWalletRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Adds an asset to an existing internal wallet. * @summary Add an asset to an internal wallet * @param {InternalWalletsApiCreateInternalWalletAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInternalWalletAsset(requestParameters: InternalWalletsApiCreateInternalWalletAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes an internal wallet by ID. * @summary Delete an internal wallet * @param {InternalWalletsApiDeleteInternalWalletRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInternalWallet(requestParameters: InternalWalletsApiDeleteInternalWalletRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a whitelisted address (for an asset) from an internal wallet. * @summary Delete a whitelisted address * @param {InternalWalletsApiDeleteInternalWalletAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInternalWalletAsset(requestParameters: InternalWalletsApiDeleteInternalWalletAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns information for an internal wallet. * @summary Get assets for internal wallet * @param {InternalWalletsApiGetInternalWalletRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWallet(requestParameters: InternalWalletsApiGetInternalWalletRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns information for an asset in an internal wallet. * @summary Get an asset from an internal wallet * @param {InternalWalletsApiGetInternalWalletAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWalletAsset(requestParameters: InternalWalletsApiGetInternalWalletAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated response of assets in an internal wallet. * @summary List assets in an internal wallet (Paginated) * @param {InternalWalletsApiGetInternalWalletAssetsPaginatedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWalletAssetsPaginated(requestParameters: InternalWalletsApiGetInternalWalletAssetsPaginatedRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets a list of internal wallets. * @summary List internal wallets * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInternalWallets(options?: RawAxiosRequestConfig): AxiosPromise; /** * Sets an AML/KYT customer reference ID for the specific internal wallet. * @summary Set an AML/KYT customer reference ID for internal wallet * @param {InternalWalletsApiSetCustomerRefIdForInternalWalletRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setCustomerRefIdForInternalWallet(requestParameters: InternalWalletsApiSetCustomerRefIdForInternalWalletRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createInternalWallet operation in InternalWalletsApi. * @export * @interface InternalWalletsApiCreateInternalWalletRequest */ export interface InternalWalletsApiCreateInternalWalletRequest { /** * * @type {CreateWalletRequest} * @memberof InternalWalletsApiCreateInternalWallet */ readonly createWalletRequest?: CreateWalletRequest; /** * 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 InternalWalletsApiCreateInternalWallet */ readonly idempotencyKey?: string; } /** * Request parameters for createInternalWalletAsset operation in InternalWalletsApi. * @export * @interface InternalWalletsApiCreateInternalWalletAssetRequest */ export interface InternalWalletsApiCreateInternalWalletAssetRequest { /** * The ID of the wallet * @type {string} * @memberof InternalWalletsApiCreateInternalWalletAsset */ readonly walletId: string; /** * The ID of the asset to add * @type {string} * @memberof InternalWalletsApiCreateInternalWalletAsset */ readonly assetId: string; /** * * @type {CreateInternalWalletAssetRequest} * @memberof InternalWalletsApiCreateInternalWalletAsset */ readonly createInternalWalletAssetRequest?: CreateInternalWalletAssetRequest; /** * 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 InternalWalletsApiCreateInternalWalletAsset */ readonly idempotencyKey?: string; } /** * Request parameters for deleteInternalWallet operation in InternalWalletsApi. * @export * @interface InternalWalletsApiDeleteInternalWalletRequest */ export interface InternalWalletsApiDeleteInternalWalletRequest { /** * The ID of the wallet to delete * @type {string} * @memberof InternalWalletsApiDeleteInternalWallet */ readonly walletId: string; } /** * Request parameters for deleteInternalWalletAsset operation in InternalWalletsApi. * @export * @interface InternalWalletsApiDeleteInternalWalletAssetRequest */ export interface InternalWalletsApiDeleteInternalWalletAssetRequest { /** * The ID of the wallet * @type {string} * @memberof InternalWalletsApiDeleteInternalWalletAsset */ readonly walletId: string; /** * The ID of the asset to delete * @type {string} * @memberof InternalWalletsApiDeleteInternalWalletAsset */ readonly assetId: string; } /** * Request parameters for getInternalWallet operation in InternalWalletsApi. * @export * @interface InternalWalletsApiGetInternalWalletRequest */ export interface InternalWalletsApiGetInternalWalletRequest { /** * The ID of the wallet to return * @type {string} * @memberof InternalWalletsApiGetInternalWallet */ readonly walletId: string; } /** * Request parameters for getInternalWalletAsset operation in InternalWalletsApi. * @export * @interface InternalWalletsApiGetInternalWalletAssetRequest */ export interface InternalWalletsApiGetInternalWalletAssetRequest { /** * The ID of the wallet * @type {string} * @memberof InternalWalletsApiGetInternalWalletAsset */ readonly walletId: string; /** * The ID of the asset to return * @type {string} * @memberof InternalWalletsApiGetInternalWalletAsset */ readonly assetId: string; } /** * Request parameters for getInternalWalletAssetsPaginated operation in InternalWalletsApi. * @export * @interface InternalWalletsApiGetInternalWalletAssetsPaginatedRequest */ export interface InternalWalletsApiGetInternalWalletAssetsPaginatedRequest { /** * The ID of the internal wallet to return assets for * @type {string} * @memberof InternalWalletsApiGetInternalWalletAssetsPaginated */ readonly walletId: string; /** * * @type {number} * @memberof InternalWalletsApiGetInternalWalletAssetsPaginated */ readonly pageSize?: number; /** * * @type {string} * @memberof InternalWalletsApiGetInternalWalletAssetsPaginated */ readonly pageCursor?: string; } /** * Request parameters for setCustomerRefIdForInternalWallet operation in InternalWalletsApi. * @export * @interface InternalWalletsApiSetCustomerRefIdForInternalWalletRequest */ export interface InternalWalletsApiSetCustomerRefIdForInternalWalletRequest { /** * * @type {SetCustomerRefIdRequest} * @memberof InternalWalletsApiSetCustomerRefIdForInternalWallet */ readonly setCustomerRefIdRequest: SetCustomerRefIdRequest; /** * The wallet ID * @type {string} * @memberof InternalWalletsApiSetCustomerRefIdForInternalWallet */ readonly walletId: 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 InternalWalletsApiSetCustomerRefIdForInternalWallet */ readonly idempotencyKey?: string; } /** * InternalWalletsApi - object-oriented interface * @export * @class InternalWalletsApi * @extends {BaseAPI} */ export declare class InternalWalletsApi extends BaseAPI { /** * Creates a new internal wallet with the requested name. Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets) * @summary Create an internal wallet * @param {InternalWalletsApiCreateInternalWalletRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ createInternalWallet(requestParameters?: InternalWalletsApiCreateInternalWalletRequest): Promise>; /** * Adds an asset to an existing internal wallet. * @summary Add an asset to an internal wallet * @param {InternalWalletsApiCreateInternalWalletAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ createInternalWalletAsset(requestParameters: InternalWalletsApiCreateInternalWalletAssetRequest): Promise>; /** * Deletes an internal wallet by ID. * @summary Delete an internal wallet * @param {InternalWalletsApiDeleteInternalWalletRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ deleteInternalWallet(requestParameters: InternalWalletsApiDeleteInternalWalletRequest): Promise>; /** * Deletes a whitelisted address (for an asset) from an internal wallet. * @summary Delete a whitelisted address * @param {InternalWalletsApiDeleteInternalWalletAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ deleteInternalWalletAsset(requestParameters: InternalWalletsApiDeleteInternalWalletAssetRequest): Promise>; /** * Returns information for an internal wallet. * @summary Get assets for internal wallet * @param {InternalWalletsApiGetInternalWalletRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ getInternalWallet(requestParameters: InternalWalletsApiGetInternalWalletRequest): Promise>; /** * Returns information for an asset in an internal wallet. * @summary Get an asset from an internal wallet * @param {InternalWalletsApiGetInternalWalletAssetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ getInternalWalletAsset(requestParameters: InternalWalletsApiGetInternalWalletAssetRequest): Promise>; /** * Returns a paginated response of assets in an internal wallet. * @summary List assets in an internal wallet (Paginated) * @param {InternalWalletsApiGetInternalWalletAssetsPaginatedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ getInternalWalletAssetsPaginated(requestParameters: InternalWalletsApiGetInternalWalletAssetsPaginatedRequest): Promise>; /** * Gets a list of internal wallets. * @summary List internal wallets * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ getInternalWallets(): Promise>; /** * Sets an AML/KYT customer reference ID for the specific internal wallet. * @summary Set an AML/KYT customer reference ID for internal wallet * @param {InternalWalletsApiSetCustomerRefIdForInternalWalletRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InternalWalletsApi */ setCustomerRefIdForInternalWallet(requestParameters: InternalWalletsApiSetCustomerRefIdForInternalWalletRequest): Promise>; }