/** * 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 { CreateEarnActionRequest } from '../models'; import { CreateEarnActionResponse } from '../models'; import { GetActionResponse } from '../models'; import { GetActionsResponse } from '../models'; import { GetOpportunitiesResponse } from '../models'; import { GetPositionsResponse } from '../models'; import { GetProvidersResponse } from '../models'; /** * EarnApi - axios parameter creator * @export */ export declare const EarnApiAxiosParamCreator: (configuration?: Configuration) => { /** * Approves earn provider terms of service for this workspace (one-time per tenant). When `isTermsApprovalRequired` is true on a provider (see list providers), call this once before creating or executing earn actions with providers that require it. After success, `GET /earn/providers` reflects `isTermsOfServiceApproved`. * @summary Approve earn provider terms of service * @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} */ approveTermsOfService: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates and runs a sequence of on-chain steps for either a deposit into or a withdrawal from an earn vault/market. Specify the operation with `action` in the request body (`DEPOSIT` or `WITHDRAW`). * @summary Create and execute a lending action (deposit or withdraw) * @param {CreateEarnActionRequest} createEarnActionRequest * @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} */ createEarnAction: (createEarnActionRequest: CreateEarnActionRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns one lending action by its action sequence id (tenant-scoped). * @summary Get a single earn lending action * @param {string} id Action sequence id (UUID). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnAction: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of lending actions (deposits and withdrawals) for the authenticated tenant. * @summary List earn lending actions * @param {string} [pageCursor] Cursor for the next or previous page of results. * @param {number} [pageSize] Number of items per page (default 100, max 100). * @param {GetEarnActionsSortByEnum} [sortBy] Field to sort results by. * @param {GetEarnActionsOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnActions: (pageCursor?: string, pageSize?: number, sortBy?: GetEarnActionsSortByEnum, order?: GetEarnActionsOrderEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get list of earn opportunities (vaults). * @summary Get list of earn opportunities * @param {string} [pageCursor] Cursor for the next or previous page of results. * @param {number} [pageSize] Number of items per page. * @param {string} [sortBy] Field to sort results by. * @param {GetEarnOpportunitiesOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnOpportunities: (pageCursor?: string, pageSize?: number, sortBy?: string, order?: GetEarnOpportunitiesOrderEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get list of earn positions for accounts tracked for this workspace. Optional query parameters filter by chain, provider, and pagination. * @summary Get list of earn positions * @param {number} [chainId] * @param {GetEarnPositionsProviderIdEnum} [providerId] * @param {string} [pageCursor] Cursor for the next or previous page of results. * @param {number} [pageSize] Number of items per page. * @param {string} [sortBy] Field to sort results by. * @param {GetEarnPositionsOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnPositions: (chainId?: number, providerId?: GetEarnPositionsProviderIdEnum, pageCursor?: string, pageSize?: number, sortBy?: string, order?: GetEarnPositionsOrderEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get list of earn providers. * @summary Get list of earn providers * @param {string} [pageCursor] Cursor for the next or previous page of results. * @param {number} [pageSize] Number of items per page. * @param {string} [sortBy] Field to sort results by. * @param {GetEarnProvidersOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnProviders: (pageCursor?: string, pageSize?: number, sortBy?: string, order?: GetEarnProvidersOrderEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * EarnApi - functional programming interface * @export */ export declare const EarnApiFp: (configuration?: Configuration) => { /** * Approves earn provider terms of service for this workspace (one-time per tenant). When `isTermsApprovalRequired` is true on a provider (see list providers), call this once before creating or executing earn actions with providers that require it. After success, `GET /earn/providers` reflects `isTermsOfServiceApproved`. * @summary Approve earn provider terms of service * @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} */ approveTermsOfService(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates and runs a sequence of on-chain steps for either a deposit into or a withdrawal from an earn vault/market. Specify the operation with `action` in the request body (`DEPOSIT` or `WITHDRAW`). * @summary Create and execute a lending action (deposit or withdraw) * @param {CreateEarnActionRequest} createEarnActionRequest * @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} */ createEarnAction(createEarnActionRequest: CreateEarnActionRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns one lending action by its action sequence id (tenant-scoped). * @summary Get a single earn lending action * @param {string} id Action sequence id (UUID). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnAction(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of lending actions (deposits and withdrawals) for the authenticated tenant. * @summary List earn lending actions * @param {string} [pageCursor] Cursor for the next or previous page of results. * @param {number} [pageSize] Number of items per page (default 100, max 100). * @param {GetEarnActionsSortByEnum} [sortBy] Field to sort results by. * @param {GetEarnActionsOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnActions(pageCursor?: string, pageSize?: number, sortBy?: GetEarnActionsSortByEnum, order?: GetEarnActionsOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get list of earn opportunities (vaults). * @summary Get list of earn opportunities * @param {string} [pageCursor] Cursor for the next or previous page of results. * @param {number} [pageSize] Number of items per page. * @param {string} [sortBy] Field to sort results by. * @param {GetEarnOpportunitiesOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnOpportunities(pageCursor?: string, pageSize?: number, sortBy?: string, order?: GetEarnOpportunitiesOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get list of earn positions for accounts tracked for this workspace. Optional query parameters filter by chain, provider, and pagination. * @summary Get list of earn positions * @param {number} [chainId] * @param {GetEarnPositionsProviderIdEnum} [providerId] * @param {string} [pageCursor] Cursor for the next or previous page of results. * @param {number} [pageSize] Number of items per page. * @param {string} [sortBy] Field to sort results by. * @param {GetEarnPositionsOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnPositions(chainId?: number, providerId?: GetEarnPositionsProviderIdEnum, pageCursor?: string, pageSize?: number, sortBy?: string, order?: GetEarnPositionsOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get list of earn providers. * @summary Get list of earn providers * @param {string} [pageCursor] Cursor for the next or previous page of results. * @param {number} [pageSize] Number of items per page. * @param {string} [sortBy] Field to sort results by. * @param {GetEarnProvidersOrderEnum} [order] Sort order (ASC or DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnProviders(pageCursor?: string, pageSize?: number, sortBy?: string, order?: GetEarnProvidersOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EarnApi - factory interface * @export */ export declare const EarnApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Approves earn provider terms of service for this workspace (one-time per tenant). When `isTermsApprovalRequired` is true on a provider (see list providers), call this once before creating or executing earn actions with providers that require it. After success, `GET /earn/providers` reflects `isTermsOfServiceApproved`. * @summary Approve earn provider terms of service * @param {EarnApiApproveTermsOfServiceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveTermsOfService(requestParameters?: EarnApiApproveTermsOfServiceRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates and runs a sequence of on-chain steps for either a deposit into or a withdrawal from an earn vault/market. Specify the operation with `action` in the request body (`DEPOSIT` or `WITHDRAW`). * @summary Create and execute a lending action (deposit or withdraw) * @param {EarnApiCreateEarnActionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEarnAction(requestParameters: EarnApiCreateEarnActionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns one lending action by its action sequence id (tenant-scoped). * @summary Get a single earn lending action * @param {EarnApiGetEarnActionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnAction(requestParameters: EarnApiGetEarnActionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of lending actions (deposits and withdrawals) for the authenticated tenant. * @summary List earn lending actions * @param {EarnApiGetEarnActionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnActions(requestParameters?: EarnApiGetEarnActionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get list of earn opportunities (vaults). * @summary Get list of earn opportunities * @param {EarnApiGetEarnOpportunitiesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnOpportunities(requestParameters?: EarnApiGetEarnOpportunitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get list of earn positions for accounts tracked for this workspace. Optional query parameters filter by chain, provider, and pagination. * @summary Get list of earn positions * @param {EarnApiGetEarnPositionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnPositions(requestParameters?: EarnApiGetEarnPositionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get list of earn providers. * @summary Get list of earn providers * @param {EarnApiGetEarnProvidersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEarnProviders(requestParameters?: EarnApiGetEarnProvidersRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for approveTermsOfService operation in EarnApi. * @export * @interface EarnApiApproveTermsOfServiceRequest */ export interface EarnApiApproveTermsOfServiceRequest { /** * 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 EarnApiApproveTermsOfService */ readonly idempotencyKey?: string; } /** * Request parameters for createEarnAction operation in EarnApi. * @export * @interface EarnApiCreateEarnActionRequest */ export interface EarnApiCreateEarnActionRequest { /** * * @type {CreateEarnActionRequest} * @memberof EarnApiCreateEarnAction */ readonly createEarnActionRequest: CreateEarnActionRequest; /** * 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 EarnApiCreateEarnAction */ readonly idempotencyKey?: string; } /** * Request parameters for getEarnAction operation in EarnApi. * @export * @interface EarnApiGetEarnActionRequest */ export interface EarnApiGetEarnActionRequest { /** * Action sequence id (UUID). * @type {string} * @memberof EarnApiGetEarnAction */ readonly id: string; } /** * Request parameters for getEarnActions operation in EarnApi. * @export * @interface EarnApiGetEarnActionsRequest */ export interface EarnApiGetEarnActionsRequest { /** * Cursor for the next or previous page of results. * @type {string} * @memberof EarnApiGetEarnActions */ readonly pageCursor?: string; /** * Number of items per page (default 100, max 100). * @type {number} * @memberof EarnApiGetEarnActions */ readonly pageSize?: number; /** * Field to sort results by. * @type {'createdAt' | 'updatedAt'} * @memberof EarnApiGetEarnActions */ readonly sortBy?: GetEarnActionsSortByEnum; /** * Sort order (ASC or DESC). * @type {'ASC' | 'DESC'} * @memberof EarnApiGetEarnActions */ readonly order?: GetEarnActionsOrderEnum; } /** * Request parameters for getEarnOpportunities operation in EarnApi. * @export * @interface EarnApiGetEarnOpportunitiesRequest */ export interface EarnApiGetEarnOpportunitiesRequest { /** * Cursor for the next or previous page of results. * @type {string} * @memberof EarnApiGetEarnOpportunities */ readonly pageCursor?: string; /** * Number of items per page. * @type {number} * @memberof EarnApiGetEarnOpportunities */ readonly pageSize?: number; /** * Field to sort results by. * @type {string} * @memberof EarnApiGetEarnOpportunities */ readonly sortBy?: string; /** * Sort order (ASC or DESC). * @type {'ASC' | 'DESC'} * @memberof EarnApiGetEarnOpportunities */ readonly order?: GetEarnOpportunitiesOrderEnum; } /** * Request parameters for getEarnPositions operation in EarnApi. * @export * @interface EarnApiGetEarnPositionsRequest */ export interface EarnApiGetEarnPositionsRequest { /** * * @type {number} * @memberof EarnApiGetEarnPositions */ readonly chainId?: number; /** * * @type {'MORPHO' | 'AAVE'} * @memberof EarnApiGetEarnPositions */ readonly providerId?: GetEarnPositionsProviderIdEnum; /** * Cursor for the next or previous page of results. * @type {string} * @memberof EarnApiGetEarnPositions */ readonly pageCursor?: string; /** * Number of items per page. * @type {number} * @memberof EarnApiGetEarnPositions */ readonly pageSize?: number; /** * Field to sort results by. * @type {string} * @memberof EarnApiGetEarnPositions */ readonly sortBy?: string; /** * Sort order (ASC or DESC). * @type {'ASC' | 'DESC'} * @memberof EarnApiGetEarnPositions */ readonly order?: GetEarnPositionsOrderEnum; } /** * Request parameters for getEarnProviders operation in EarnApi. * @export * @interface EarnApiGetEarnProvidersRequest */ export interface EarnApiGetEarnProvidersRequest { /** * Cursor for the next or previous page of results. * @type {string} * @memberof EarnApiGetEarnProviders */ readonly pageCursor?: string; /** * Number of items per page. * @type {number} * @memberof EarnApiGetEarnProviders */ readonly pageSize?: number; /** * Field to sort results by. * @type {string} * @memberof EarnApiGetEarnProviders */ readonly sortBy?: string; /** * Sort order (ASC or DESC). * @type {'ASC' | 'DESC'} * @memberof EarnApiGetEarnProviders */ readonly order?: GetEarnProvidersOrderEnum; } /** * EarnApi - object-oriented interface * @export * @class EarnApi * @extends {BaseAPI} */ export declare class EarnApi extends BaseAPI { /** * Approves earn provider terms of service for this workspace (one-time per tenant). When `isTermsApprovalRequired` is true on a provider (see list providers), call this once before creating or executing earn actions with providers that require it. After success, `GET /earn/providers` reflects `isTermsOfServiceApproved`. * @summary Approve earn provider terms of service * @param {EarnApiApproveTermsOfServiceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EarnApi */ approveTermsOfService(requestParameters?: EarnApiApproveTermsOfServiceRequest): Promise>; /** * Creates and runs a sequence of on-chain steps for either a deposit into or a withdrawal from an earn vault/market. Specify the operation with `action` in the request body (`DEPOSIT` or `WITHDRAW`). * @summary Create and execute a lending action (deposit or withdraw) * @param {EarnApiCreateEarnActionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EarnApi */ createEarnAction(requestParameters: EarnApiCreateEarnActionRequest): Promise>; /** * Returns one lending action by its action sequence id (tenant-scoped). * @summary Get a single earn lending action * @param {EarnApiGetEarnActionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EarnApi */ getEarnAction(requestParameters: EarnApiGetEarnActionRequest): Promise>; /** * Returns a paginated list of lending actions (deposits and withdrawals) for the authenticated tenant. * @summary List earn lending actions * @param {EarnApiGetEarnActionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EarnApi */ getEarnActions(requestParameters?: EarnApiGetEarnActionsRequest): Promise>; /** * Get list of earn opportunities (vaults). * @summary Get list of earn opportunities * @param {EarnApiGetEarnOpportunitiesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EarnApi */ getEarnOpportunities(requestParameters?: EarnApiGetEarnOpportunitiesRequest): Promise>; /** * Get list of earn positions for accounts tracked for this workspace. Optional query parameters filter by chain, provider, and pagination. * @summary Get list of earn positions * @param {EarnApiGetEarnPositionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EarnApi */ getEarnPositions(requestParameters?: EarnApiGetEarnPositionsRequest): Promise>; /** * Get list of earn providers. * @summary Get list of earn providers * @param {EarnApiGetEarnProvidersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EarnApi */ getEarnProviders(requestParameters?: EarnApiGetEarnProvidersRequest): Promise>; } /** * @export */ export declare const GetEarnActionsSortByEnum: { readonly CreatedAt: "createdAt"; readonly UpdatedAt: "updatedAt"; }; export type GetEarnActionsSortByEnum = typeof GetEarnActionsSortByEnum[keyof typeof GetEarnActionsSortByEnum]; /** * @export */ export declare const GetEarnActionsOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetEarnActionsOrderEnum = typeof GetEarnActionsOrderEnum[keyof typeof GetEarnActionsOrderEnum]; /** * @export */ export declare const GetEarnOpportunitiesOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetEarnOpportunitiesOrderEnum = typeof GetEarnOpportunitiesOrderEnum[keyof typeof GetEarnOpportunitiesOrderEnum]; /** * @export */ export declare const GetEarnPositionsProviderIdEnum: { readonly Morpho: "MORPHO"; readonly Aave: "AAVE"; }; export type GetEarnPositionsProviderIdEnum = typeof GetEarnPositionsProviderIdEnum[keyof typeof GetEarnPositionsProviderIdEnum]; /** * @export */ export declare const GetEarnPositionsOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetEarnPositionsOrderEnum = typeof GetEarnPositionsOrderEnum[keyof typeof GetEarnPositionsOrderEnum]; /** * @export */ export declare const GetEarnProvidersOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetEarnProvidersOrderEnum = typeof GetEarnProvidersOrderEnum[keyof typeof GetEarnProvidersOrderEnum];