@northstake/northstakeapi 1.0.38 → 1.0.40

package/api/lidoReadApi.ts

@@ -0,0 +1,646 @@
+/**
+ * Northstake
+ * Northstake api  Operation-level extensions used by the API: - x-roleRequired (array of strings): roles required to call the operation. - x-mfaApiScope (array of strings): MFA API scopes required when the user has MFA enrolled. - x-isProSvmFeature (boolean): when true, the operation is restricted to users whose Cosmos user document has is_pro_svm_user set to true. 
+ *
+ * The version of the OpenAPI document: 1.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 localVarRequest from 'request';
+import http from 'http';
+
+/* tslint:disable:no-unused-locals */
+import { ErrorResponse } from '../model/errorResponse';
+import { GetLazyOracleReportData200Response } from '../model/getLazyOracleReportData200Response';
+import { GetLidoTransactions200Response } from '../model/getLidoTransactions200Response';
+import { GetQuarantineInfo200Response } from '../model/getQuarantineInfo200Response';
+import { GetStETHPerWstETHRate200Response } from '../model/getStETHPerWstETHRate200Response';
+
+import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
+import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth, JWTAuth } from '../model/models';
+
+import { HttpError, RequestFile } from './apis';
+
+let defaultBasePath = 'https://api.northstake.dk/v1';
+
+// ===============================================
+// This file is autogenerated - Please do not edit
+// ===============================================
+
+export enum LidoReadApiApiKeys {
+    ApiKeyAuth,
+}
+
+
+// If vendorExtensions.x-packageParams is true, use a single object to pass parameters
+export interface LidoReadApiParams {
+    contractsId?: string;
+    startDate?: Date;
+    endDate?: Date;
+    page?: number;
+    limit?: number;
+}
+// If vendorExtensions.x-packageParams is true, use a single object to pass parameters
+export interface LidoReadApiParams {
+    contractsId?: string;
+    startDate?: Date;
+    endDate?: Date;
+}
+
+export class LidoReadApi {
+    protected _basePath = defaultBasePath;
+    protected _defaultHeaders : any = {};
+    protected _useQuerystring : boolean = false;
+
+    protected authentications = {
+        'default': <Authentication>new JWTAuth('your_api_key', 'your_private_key'),
+        'bearerTokenAuth': new HttpBearerAuth(),
+        'ApiKeyAuth': new ApiKeyAuth('header', 'x-api-key'),
+    }
+
+    protected interceptors: Interceptor[] = [];
+
+    constructor(basePath?: string);
+    constructor(basePathOrUsername: string, password?: string, basePath?: string) {
+        if (password) {
+            if (basePath) {
+                this.basePath = basePath;
+            }
+        } else {
+            if (basePathOrUsername) {
+                this.basePath = basePathOrUsername
+            }
+        }
+    }
+
+    set useQuerystring(value: boolean) {
+        this._useQuerystring = value;
+    }
+
+    set basePath(basePath: string) {
+        this._basePath = basePath;
+    }
+
+    set defaultHeaders(defaultHeaders: any) {
+        this._defaultHeaders = defaultHeaders;
+    }
+
+    get defaultHeaders() {
+        return this._defaultHeaders;
+    }
+
+    get basePath() {
+        return this._basePath;
+    }
+
+    public setDefaultAuthentication(auth: Authentication) {
+        this.authentications.default = auth;
+    }
+
+    public setApiKey(key: LidoReadApiApiKeys, value: string) {
+        (this.authentications as any)[LidoReadApiApiKeys[key]].apiKey = value;
+    }
+
+    set accessToken(accessToken: string | (() => string)) {
+        this.authentications.bearerTokenAuth.accessToken = accessToken;
+    }
+
+    public addInterceptor(interceptor: Interceptor) {
+        this.interceptors.push(interceptor);
+    }
+
+    /**
+     * 
+     * @summary Get dashboard role members for a vault
+     * @param contractsId The unique identifier of the Lido staking contracts
+     */
+
+   
+
+
+
+   public async getAllDashboardRoleMembers (contractsId: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ body: { [key: string]: Array<string>; }, status: number }> {
+
+        const localVarPath = this.basePath + '/lidov3/{contractsId}/all-dashboard-role-members'
+            .replace('{' + 'contractsId' + '}', encodeURIComponent(String(contractsId)));
+       
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        } else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+
+
+        // Verify required parameter 'contractsId' is not null or undefined
+        if (contractsId === null || contractsId === undefined) {
+            throw new Error('Required parameter "contractsId" was null or undefined when calling getAllDashboardRoleMembers.');
+        }
+
+
+
+
+
+
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
+        return interceptorPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+                 return new Promise<{ body: { [key: string]: Array<string>; }, status: number }>((resolve, reject) => {
+            localVarRequest(localVarRequestOptions, (error, response, body) => {
+                if (error) {
+                    console.error('API call error:', error);
+                    reject(error);
+                } else {
+                    if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                        body = ObjectSerializer.deserialize(body, "{ [key: string]: Array<string>; }");
+                        resolve({ body: body, status: response.statusCode });
+                    } else {
+                        console.error('API response error:', response.statusCode);
+                        resolve({ body: body, status: response.statusCode });
+                    }
+                }
+            });
+        });
+    } )
+}
+    /**
+     * 
+     * @summary Get vault report data from lazy oracle
+     * @param contractsId The unique identifier of the Lido staking contracts
+     */
+
+   
+
+
+
+   public async getLazyOracleReportData (contractsId: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ body: GetLazyOracleReportData200Response, status: number }> {
+
+        const localVarPath = this.basePath + '/lidov3/{contractsId}/vault-report-data'
+            .replace('{' + 'contractsId' + '}', encodeURIComponent(String(contractsId)));
+       
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        } else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+
+
+        // Verify required parameter 'contractsId' is not null or undefined
+        if (contractsId === null || contractsId === undefined) {
+            throw new Error('Required parameter "contractsId" was null or undefined when calling getLazyOracleReportData.');
+        }
+
+
+
+
+
+
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
+        return interceptorPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+                 return new Promise<{ body: GetLazyOracleReportData200Response, status: number }>((resolve, reject) => {
+            localVarRequest(localVarRequestOptions, (error, response, body) => {
+                if (error) {
+                    console.error('API call error:', error);
+                    reject(error);
+                } else {
+                    if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                        body = ObjectSerializer.deserialize(body, "GetLazyOracleReportData200Response");
+                        resolve({ body: body, status: response.statusCode });
+                    } else {
+                        console.error('API response error:', response.statusCode);
+                        resolve({ body: body, status: response.statusCode });
+                    }
+                }
+            });
+        });
+    } )
+}
+    /**
+     * Retrieves transactions for all staking vaults. Optionally filter by a specific contractsId.
+     * @summary Get transactions related to Lido staking contract sets
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, returns transactions for all staking vaults.
+     * @param startDate Start date for filtering transactions
+     * @param endDate End date for filtering transactions
+     * @param page Page number for pagination
+     * @param limit Number of transactions per page
+     */
+
+   
+
+
+
+    public async getLidoTransactions(params?: LidoReadApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: GetLidoTransactions200Response, status: number }> {
+
+        const localVarPath = this.basePath + '/lidov3/transactions';
+       
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        } else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+
+
+
+
+
+    if (params?.contractsId !== undefined) {
+        localVarQueryParameters['contractsId'] = ObjectSerializer.serialize(params?.contractsId, "string");
+    }
+    if (params?.startDate !== undefined) {
+        localVarQueryParameters['start_date'] = ObjectSerializer.serialize(params?.startDate, "Date");
+    }
+    if (params?.endDate !== undefined) {
+        localVarQueryParameters['end_date'] = ObjectSerializer.serialize(params?.endDate, "Date");
+    }
+    if (params?.page !== undefined) {
+        localVarQueryParameters['page'] = ObjectSerializer.serialize(params?.page, "number");
+    }
+    if (params?.limit !== undefined) {
+        localVarQueryParameters['limit'] = ObjectSerializer.serialize(params?.limit, "number");
+    }
+
+
+
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
+        return interceptorPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+                 return new Promise<{ body: GetLidoTransactions200Response, status: number }>((resolve, reject) => {
+            localVarRequest(localVarRequestOptions, (error, response, body) => {
+                if (error) {
+                    console.error('API call error:', error);
+                    reject(error);
+                } else {
+                    if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                        body = ObjectSerializer.deserialize(body, "GetLidoTransactions200Response");
+                        resolve({ body: body, status: response.statusCode });
+                    } else {
+                        console.error('API response error:', response.statusCode);
+                        resolve({ body: body, status: response.statusCode });
+                    }
+                }
+            });
+        });
+    } )
+}
+    /**
+     * 
+     * @summary Get quarantine info for a vault
+     * @param contractsId The unique identifier of the Lido staking contracts
+     */
+
+   
+
+
+
+   public async getQuarantineInfo (contractsId: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ body: GetQuarantineInfo200Response, status: number }> {
+
+        const localVarPath = this.basePath + '/lidov3/{contractsId}/quarantine-info'
+            .replace('{' + 'contractsId' + '}', encodeURIComponent(String(contractsId)));
+       
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        } else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+
+
+        // Verify required parameter 'contractsId' is not null or undefined
+        if (contractsId === null || contractsId === undefined) {
+            throw new Error('Required parameter "contractsId" was null or undefined when calling getQuarantineInfo.');
+        }
+
+
+
+
+
+
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
+        return interceptorPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+                 return new Promise<{ body: GetQuarantineInfo200Response, status: number }>((resolve, reject) => {
+            localVarRequest(localVarRequestOptions, (error, response, body) => {
+                if (error) {
+                    console.error('API call error:', error);
+                    reject(error);
+                } else {
+                    if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                        body = ObjectSerializer.deserialize(body, "GetQuarantineInfo200Response");
+                        resolve({ body: body, status: response.statusCode });
+                    } else {
+                        console.error('API response error:', response.statusCode);
+                        resolve({ body: body, status: response.statusCode });
+                    }
+                }
+            });
+        });
+    } )
+}
+    /**
+     * 
+     * @summary Get the current stETH per wstETH exchange rate
+     */
+
+   
+
+
+
+   public async getStETHPerWstETHRate (options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ body: GetStETHPerWstETHRate200Response, status: number }> {
+
+        const localVarPath = this.basePath + '/lidov3/steth-per-wsteth-rate';
+       
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        } else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+
+
+
+
+
+
+
+
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
+        return interceptorPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+                 return new Promise<{ body: GetStETHPerWstETHRate200Response, status: number }>((resolve, reject) => {
+            localVarRequest(localVarRequestOptions, (error, response, body) => {
+                if (error) {
+                    console.error('API call error:', error);
+                    reject(error);
+                } else {
+                    if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                        body = ObjectSerializer.deserialize(body, "GetStETHPerWstETHRate200Response");
+                        resolve({ body: body, status: response.statusCode });
+                    } else {
+                        console.error('API response error:', response.statusCode);
+                        resolve({ body: body, status: response.statusCode });
+                    }
+                }
+            });
+        });
+    } )
+}
+    /**
+     * Creates an internal order document for CSV export of transactions. The backend janitor will process this order and send the CSV via email.
+     * @summary Request CSV export for transactions
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, exports transactions for all staking vaults.
+     * @param startDate Start date for filtering transactions
+     * @param endDate End date for filtering transactions
+     */
+
+   
+
+
+
+    public async requestTransactionsCsvExport(params?: LidoReadApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: any, status: number }> {
+
+        const localVarPath = this.basePath + '/lidov3/transactions/csv-export';
+       
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        } else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+
+
+
+
+
+    if (params?.contractsId !== undefined) {
+        localVarQueryParameters['contractsId'] = ObjectSerializer.serialize(params?.contractsId, "string");
+    }
+    if (params?.startDate !== undefined) {
+        localVarQueryParameters['start_date'] = ObjectSerializer.serialize(params?.startDate, "Date");
+    }
+    if (params?.endDate !== undefined) {
+        localVarQueryParameters['end_date'] = ObjectSerializer.serialize(params?.endDate, "Date");
+    }
+
+
+
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
+        return interceptorPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+                 return new Promise<{ body: any, status: number }>((resolve, reject) => {
+            localVarRequest(localVarRequestOptions, (error, response, body) => {
+                if (error) {
+                    console.error('API call error:', error);
+                    reject(error);
+                } else {
+                    if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                        resolve({ body: body, status: response.statusCode });
+                    } else {
+                        console.error('API response error:', response.statusCode);
+                        resolve({ body: body, status: response.statusCode });
+                    }
+                }
+            });
+        });
+    } )
+}
+}