@ember-finance/sdk 1.0.9 → 1.0.10

package/dist/src/vaults/api/apis/vaults-api.d.ts

@@ -9,25 +9,25 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { Configuration } from "../configuration";
-import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from "axios";
-import globalAxios from "axios";
-import { type RequestArgs, BaseAPI } from "../base";
-import type { ApyHistory } from "../models";
-import type { CoinPrice } from "../models";
-import type { Exposure } from "../models";
-import type { HistoryInterval } from "../models";
-import type { PnlHistory } from "../models";
-import type { PnlHistoryInterval } from "../models";
-import type { ProtocolInfo } from "../models";
-import type { RawEvent } from "../models";
-import type { SharePriceHistory } from "../models";
-import type { Strategy } from "../models";
-import type { TvlHistory } from "../models";
-import type { UpdateVaultStrategies } from "../models";
-import type { VaultDetail } from "../models";
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { ApyHistory } from '../models';
+import type { CoinPrice } from '../models';
+import type { Exposure } from '../models';
+import type { HistoryInterval } from '../models';
+import type { PnlHistory } from '../models';
+import type { PnlHistoryInterval } from '../models';
+import type { ProtocolInfo } from '../models';
+import type { RawEvent } from '../models';
+import type { SharePriceHistory } from '../models';
+import type { Strategy } from '../models';
+import type { TvlHistory } from '../models';
+import type { UpdateVaultStrategies } from '../models';
+import type { VaultDetail } from '../models';
 /**
  * VaultsApi - axios parameter creator
+ * @export
  */
 export declare const VaultsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -150,6 +150,7 @@ export declare const VaultsApiAxiosParamCreator: (configuration?: Configuration)
 };
 /**
  * VaultsApi - functional programming interface
+ * @export
  */
 export declare const VaultsApiFp: (configuration?: Configuration) => {
     /**
@@ -272,6 +273,7 @@ export declare const VaultsApiFp: (configuration?: Configuration) => {
 };
 /**
  * VaultsApi - factory interface
+ * @export
  */
 export declare const VaultsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -392,18 +394,159 @@ export declare const VaultsApiFactory: (configuration?: Configuration, basePath?
      */
     updateVaultStrategy(updateVaultStrategies: UpdateVaultStrategies, options?: RawAxiosRequestConfig): AxiosPromise<Array<Strategy>>;
 };
+/**
+ * VaultsApi - interface
+ * @export
+ * @interface VaultsApi
+ */
+export interface VaultsApiInterface {
+    /**
+     *
+     * @summary Get the price of the coins
+     * @param {string} [coinTypes] The coin types of the coins
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getCoinsPrice(coinTypes?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoinPrice>>;
+    /**
+     *
+     * @summary Get the pnl history of the protocol (1h, 1d, 1w, 1mon) descending by time
+     * @param {number} [limit] The limit of the rows
+     * @param {PnlHistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getProtocolPnlHistory(limit?: number, interval?: PnlHistoryInterval, options?: RawAxiosRequestConfig): AxiosPromise<Array<PnlHistory>>;
+    /**
+     *
+     * @summary Get the tvl history of the protocol (1h, 1d, 1w, 1mon) descending by time
+     * @param {number} [limit] The limit of the rows
+     * @param {HistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getProtocolTvlHistory(limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): AxiosPromise<Array<TvlHistory>>;
+    /**
+     *
+     * @summary Get raw events of the protocol
+     * @param {number} startTimeInMs The start time of the events
+     * @param {number} [endTimeInMs] The end time of the events
+     * @param {number} [limit] The limit of the events
+     * @param {number} [page] Use when provided time range and limit exceed max page size
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getRawEvents(startTimeInMs: number, endTimeInMs?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<RawEvent>>;
+    /**
+     *
+     * @summary Get the apy history of the vault (1h, 1d, 1w, 1mon) descending by time
+     * @param {string} vaultId The id of the vault
+     * @param {number} [limit] The limit of the rows
+     * @param {HistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getVaultApyHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApyHistory>>;
+    /**
+     *
+     * @summary Get the exposure of the vault
+     * @param {string} vaultId The id of the vault
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getVaultExposure(vaultId: string, options?: RawAxiosRequestConfig): AxiosPromise<Exposure>;
+    /**
+     *
+     * @summary Get the pnl history of the vault (1h, 1d, 1w, 1mon) descending by time
+     * @param {string} vaultId The id of the vault
+     * @param {number} [limit] The limit of the rows
+     * @param {PnlHistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getVaultPnlHistory(vaultId: string, limit?: number, interval?: PnlHistoryInterval, options?: RawAxiosRequestConfig): AxiosPromise<Array<PnlHistory>>;
+    /**
+     *
+     * @summary Get the share price history of the vault (1h, 1d, 1w, 1mon) descending by time
+     * @param {string} vaultId The id of the vault
+     * @param {number} [limit] The limit of the rows
+     * @param {HistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getVaultSharePriceHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): AxiosPromise<Array<SharePriceHistory>>;
+    /**
+     *
+     * @summary Get the strategy of the vault
+     * @param {string} vaultId The id of the vault
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getVaultStrategy(vaultId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Strategy>>;
+    /**
+     *
+     * @summary Get the tvl history of the vault (1h, 1d, 1w, 1mon) descending by time
+     * @param {string} vaultId The id of the vault
+     * @param {number} [limit] The limit of the rows
+     * @param {HistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getVaultTvlHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): AxiosPromise<Array<TvlHistory>>;
+    /**
+     *
+     * @summary Get details for all vaults or a specific vault
+     * @param {string} [vaultId] The ID of the vault
+     * @param {string} [receiptCoinSymbol] The receipt coin symbol of the vault
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getVaults(vaultId?: string, receiptCoinSymbol?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<VaultDetail>>;
+    /**
+     *
+     * @summary Get protocol info to initialize sdk
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    getVaultsProtocolInfo(options?: RawAxiosRequestConfig): AxiosPromise<ProtocolInfo>;
+    /**
+     *
+     * @summary Update the strategy of the vault
+     * @param {UpdateVaultStrategies} updateVaultStrategies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VaultsApiInterface
+     */
+    updateVaultStrategy(updateVaultStrategies: UpdateVaultStrategies, options?: RawAxiosRequestConfig): AxiosPromise<Array<Strategy>>;
+}
 /**
  * VaultsApi - object-oriented interface
+ * @export
+ * @class VaultsApi
+ * @extends {BaseAPI}
  */
-export declare class VaultsApi extends BaseAPI {
+export declare class VaultsApi extends BaseAPI implements VaultsApiInterface {
     /**
      *
      * @summary Get the price of the coins
      * @param {string} [coinTypes] The coin types of the coins
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getCoinsPrice(coinTypes?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CoinPrice[], any, {}>>;
+    getCoinsPrice(coinTypes?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoinPrice[], any, {}>>;
     /**
      *
      * @summary Get the pnl history of the protocol (1h, 1d, 1w, 1mon) descending by time
@@ -411,8 +554,9 @@ export declare class VaultsApi extends BaseAPI {
      * @param {PnlHistoryInterval} [interval] The interval of the rows
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getProtocolPnlHistory(limit?: number, interval?: PnlHistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PnlHistory[], any, {}>>;
+    getProtocolPnlHistory(limit?: number, interval?: PnlHistoryInterval, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PnlHistory[], any, {}>>;
     /**
      *
      * @summary Get the tvl history of the protocol (1h, 1d, 1w, 1mon) descending by time
@@ -420,8 +564,9 @@ export declare class VaultsApi extends BaseAPI {
      * @param {HistoryInterval} [interval] The interval of the rows
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getProtocolTvlHistory(limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TvlHistory[], any, {}>>;
+    getProtocolTvlHistory(limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TvlHistory[], any, {}>>;
     /**
      *
      * @summary Get raw events of the protocol
@@ -431,8 +576,9 @@ export declare class VaultsApi extends BaseAPI {
      * @param {number} [page] Use when provided time range and limit exceed max page size
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getRawEvents(startTimeInMs: number, endTimeInMs?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RawEvent[], any, {}>>;
+    getRawEvents(startTimeInMs: number, endTimeInMs?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RawEvent[], any, {}>>;
     /**
      *
      * @summary Get the apy history of the vault (1h, 1d, 1w, 1mon) descending by time
@@ -441,16 +587,18 @@ export declare class VaultsApi extends BaseAPI {
      * @param {HistoryInterval} [interval] The interval of the rows
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getVaultApyHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ApyHistory[], any, {}>>;
+    getVaultApyHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApyHistory[], any, {}>>;
     /**
      *
      * @summary Get the exposure of the vault
      * @param {string} vaultId The id of the vault
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getVaultExposure(vaultId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Exposure, any, {}>>;
+    getVaultExposure(vaultId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Exposure, any, {}>>;
     /**
      *
      * @summary Get the pnl history of the vault (1h, 1d, 1w, 1mon) descending by time
@@ -459,8 +607,9 @@ export declare class VaultsApi extends BaseAPI {
      * @param {PnlHistoryInterval} [interval] The interval of the rows
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getVaultPnlHistory(vaultId: string, limit?: number, interval?: PnlHistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PnlHistory[], any, {}>>;
+    getVaultPnlHistory(vaultId: string, limit?: number, interval?: PnlHistoryInterval, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PnlHistory[], any, {}>>;
     /**
      *
      * @summary Get the share price history of the vault (1h, 1d, 1w, 1mon) descending by time
@@ -469,16 +618,18 @@ export declare class VaultsApi extends BaseAPI {
      * @param {HistoryInterval} [interval] The interval of the rows
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getVaultSharePriceHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SharePriceHistory[], any, {}>>;
+    getVaultSharePriceHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SharePriceHistory[], any, {}>>;
     /**
      *
      * @summary Get the strategy of the vault
      * @param {string} vaultId The id of the vault
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getVaultStrategy(vaultId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Strategy[], any, {}>>;
+    getVaultStrategy(vaultId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Strategy[], any, {}>>;
     /**
      *
      * @summary Get the tvl history of the vault (1h, 1d, 1w, 1mon) descending by time
@@ -487,8 +638,9 @@ export declare class VaultsApi extends BaseAPI {
      * @param {HistoryInterval} [interval] The interval of the rows
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getVaultTvlHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TvlHistory[], any, {}>>;
+    getVaultTvlHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TvlHistory[], any, {}>>;
     /**
      *
      * @summary Get details for all vaults or a specific vault
@@ -496,21 +648,24 @@ export declare class VaultsApi extends BaseAPI {
      * @param {string} [receiptCoinSymbol] The receipt coin symbol of the vault
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getVaults(vaultId?: string, receiptCoinSymbol?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<VaultDetail[], any, {}>>;
+    getVaults(vaultId?: string, receiptCoinSymbol?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VaultDetail[], any, {}>>;
     /**
      *
      * @summary Get protocol info to initialize sdk
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    getVaultsProtocolInfo(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ProtocolInfo, any, {}>>;
+    getVaultsProtocolInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProtocolInfo, any, {}>>;
     /**
      *
      * @summary Update the strategy of the vault
      * @param {UpdateVaultStrategies} updateVaultStrategies
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VaultsApi
      */
-    updateVaultStrategy(updateVaultStrategies: UpdateVaultStrategies, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Strategy[], any, {}>>;
+    updateVaultStrategy(updateVaultStrategies: UpdateVaultStrategies, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Strategy[], any, {}>>;
 }