@ember-finance/sdk 0.0.1 → 1.0.1

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

@@ -0,0 +1,441 @@
+/**
+ * Ember Protocol Vaults API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * 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 globalAxios from "axios";
+import { type RequestArgs, BaseAPI } from "../base";
+import type { Exposure } from "../models";
+import type { HistoryInterval } from "../models";
+import type { PnlHistory } 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 declare const VaultsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Get the pnl 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}
+     */
+    getProtocolPnlHistory: (limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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}
+     */
+    getProtocolTvlHistory: (limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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}
+     */
+    getRawEvents: (startTimeInMs: number, endTimeInMs?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get the exposure of the vault
+     * @param {string} vaultId The id of the vault
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultExposure: (vaultId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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 {HistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultPnlHistory: (vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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}
+     */
+    getVaultSharePriceHistory: (vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get the strategy of the vault
+     * @param {string} vaultId The id of the vault
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultStrategy: (vaultId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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}
+     */
+    getVaultTvlHistory: (vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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}
+     */
+    getVaults: (vaultId?: string, receiptCoinSymbol?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get protocol info to initialize sdk
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultsProtocolInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update the strategy of the vault
+     * @param {UpdateVaultStrategies} updateVaultStrategies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVaultStrategy: (updateVaultStrategies: UpdateVaultStrategies, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * VaultsApi - functional programming interface
+ */
+export declare const VaultsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Get the pnl 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}
+     */
+    getProtocolPnlHistory(limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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}
+     */
+    getProtocolTvlHistory(limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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}
+     */
+    getRawEvents(startTimeInMs: number, endTimeInMs?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RawEvent>>>;
+    /**
+     *
+     * @summary Get the exposure of the vault
+     * @param {string} vaultId The id of the vault
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultExposure(vaultId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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 {HistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultPnlHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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}
+     */
+    getVaultSharePriceHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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}
+     */
+    getVaultStrategy(vaultId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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}
+     */
+    getVaultTvlHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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}
+     */
+    getVaults(vaultId?: string, receiptCoinSymbol?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VaultDetail>>>;
+    /**
+     *
+     * @summary Get protocol info to initialize sdk
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultsProtocolInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProtocolInfo>>;
+    /**
+     *
+     * @summary Update the strategy of the vault
+     * @param {UpdateVaultStrategies} updateVaultStrategies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVaultStrategy(updateVaultStrategies: UpdateVaultStrategies, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Strategy>>>;
+};
+/**
+ * VaultsApi - factory interface
+ */
+export declare const VaultsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Get the pnl 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}
+     */
+    getProtocolPnlHistory(limit?: number, interval?: HistoryInterval, 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}
+     */
+    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}
+     */
+    getRawEvents(startTimeInMs: number, endTimeInMs?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<RawEvent>>;
+    /**
+     *
+     * @summary Get the exposure of the vault
+     * @param {string} vaultId The id of the vault
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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 {HistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultPnlHistory(vaultId: string, limit?: number, interval?: HistoryInterval, 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}
+     */
+    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}
+     */
+    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}
+     */
+    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}
+     */
+    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}
+     */
+    getVaultsProtocolInfo(options?: RawAxiosRequestConfig): AxiosPromise<ProtocolInfo>;
+    /**
+     *
+     * @summary Update the strategy of the vault
+     * @param {UpdateVaultStrategies} updateVaultStrategies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVaultStrategy(updateVaultStrategies: UpdateVaultStrategies, options?: RawAxiosRequestConfig): AxiosPromise<Array<Strategy>>;
+};
+/**
+ * VaultsApi - object-oriented interface
+ */
+export declare class VaultsApi extends BaseAPI {
+    /**
+     *
+     * @summary Get the pnl 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}
+     */
+    getProtocolPnlHistory(limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PnlHistory[], any>>;
+    /**
+     *
+     * @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}
+     */
+    getProtocolTvlHistory(limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TvlHistory[], any>>;
+    /**
+     *
+     * @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}
+     */
+    getRawEvents(startTimeInMs: number, endTimeInMs?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RawEvent[], any>>;
+    /**
+     *
+     * @summary Get the exposure of the vault
+     * @param {string} vaultId The id of the vault
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultExposure(vaultId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Exposure, any>>;
+    /**
+     *
+     * @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 {HistoryInterval} [interval] The interval of the rows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultPnlHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PnlHistory[], any>>;
+    /**
+     *
+     * @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}
+     */
+    getVaultSharePriceHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.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}
+     */
+    getVaultStrategy(vaultId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Strategy[], any>>;
+    /**
+     *
+     * @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}
+     */
+    getVaultTvlHistory(vaultId: string, limit?: number, interval?: HistoryInterval, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TvlHistory[], any>>;
+    /**
+     *
+     * @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}
+     */
+    getVaults(vaultId?: string, receiptCoinSymbol?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<VaultDetail[], any>>;
+    /**
+     *
+     * @summary Get protocol info to initialize sdk
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVaultsProtocolInfo(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ProtocolInfo, any>>;
+    /**
+     *
+     * @summary Update the strategy of the vault
+     * @param {UpdateVaultStrategies} updateVaultStrategies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateVaultStrategy(updateVaultStrategies: UpdateVaultStrategies, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Strategy[], any>>;
+}