@northstake/northstakeapi 1.0.38 → 1.0.39

package/api/{smartContractsApi.ts → lidoRewardsApi.ts}

@@ -1,6 +1,6 @@
 /**
  * Northstake
- * Northstake api
+ * 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
  * 
@@ -16,10 +16,8 @@ import http from 'http';
 
 /* tslint:disable:no-unused-locals */
 import { ErrorResponse } from '../model/errorResponse';
-import { GetSmartContractMEVRewards200Response } from '../model/getSmartContractMEVRewards200Response';
-import { GetSmartContractMinedBlocks200Response } from '../model/getSmartContractMinedBlocks200Response';
-import { GetSmartContractTransactions200Response } from '../model/getSmartContractTransactions200Response';
-import { SmartContractDetailed } from '../model/smartContractDetailed';
+import { ValidatorRewardsDailyResponse } from '../model/validatorRewardsDailyResponse';
+import { ValidatorRewardsRaw } from '../model/validatorRewardsRaw';
 
 import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
 import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth, JWTAuth } from '../model/models';
@@ -32,37 +30,45 @@ let defaultBasePath = 'https://api.northstake.dk/v1';
 // This file is autogenerated - Please do not edit
 // ===============================================
 
-export enum SmartContractsApiApiKeys {
+export enum LidoRewardsApiApiKeys {
     ApiKeyAuth,
 }
 
 
 // If vendorExtensions.x-packageParams is true, use a single object to pass parameters
-export interface SmartContractsApiParams {
-    contractAddress: string;
-    page?: number;
-    limit?: number;
+export interface LidoRewardsApiParams {
+    contractsId?: string;
     startDate?: Date;
     endDate?: Date;
+    page?: number;
+    limit?: number;
+    rewardType?: 'consensus' | 'block' | 'mev';
 }
 // If vendorExtensions.x-packageParams is true, use a single object to pass parameters
-export interface SmartContractsApiParams {
-    contractAddress: string;
+export interface LidoRewardsApiParams {
+    contractsId?: string;
+    startDate?: Date;
+    endDate?: Date;
     page?: number;
     limit?: number;
+    rewardType?: 'consensus' | 'block' | 'mev';
+}
+// If vendorExtensions.x-packageParams is true, use a single object to pass parameters
+export interface LidoRewardsApiParams {
+    contractsId?: string;
     startDate?: Date;
     endDate?: Date;
+    rewardType?: 'consensus' | 'block' | 'mev';
 }
 // If vendorExtensions.x-packageParams is true, use a single object to pass parameters
-export interface SmartContractsApiParams {
-    contractAddress: string;
+export interface LidoRewardsApiParams {
+    contractsId?: string;
     startDate?: Date;
     endDate?: Date;
-    page?: number;
-    limit?: number;
+    rewardType?: 'consensus' | 'block' | 'mev';
 }
 
-export class SmartContractsApi {
+export class LidoRewardsApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {};
     protected _useQuerystring : boolean = false;
@@ -112,8 +118,8 @@ export class SmartContractsApi {
         this.authentications.default = auth;
     }
 
-    public setApiKey(key: SmartContractsApiApiKeys, value: string) {
-        (this.authentications as any)[SmartContractsApiApiKeys[key]].apiKey = value;
+    public setApiKey(key: LidoRewardsApiApiKeys, value: string) {
+        (this.authentications as any)[LidoRewardsApiApiKeys[key]].apiKey = value;
     }
 
     set accessToken(accessToken: string | (() => string)) {
@@ -125,23 +131,23 @@ export class SmartContractsApi {
     }
 
     /**
-     * 
-     * @summary Get MEV rewards related to a specific smart contract
-     * @param contractAddress The address of the smart contract
+     * Retrieves a paginated list of daily aggregated validator rewards for all staking vaults, aggregated by date, reward type, and staking vault. Optionally filter by a specific contractsId. Supports filtering by date range and reward type.
+     * @summary Get daily aggregated validator rewards for staking vaults
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, returns rewards for all staking vaults.
+     * @param startDate Start date for filtering rewards
+     * @param endDate End date for filtering rewards
      * @param page Page number for pagination
-     * @param limit Number of MEV rewards per page
-     * @param startDate Start date for filtering MEV rewards
-     * @param endDate End date for filtering MEV rewards
+     * @param limit Number of daily reward records per page
+     * @param rewardType Filter by reward type
      */
 
    
 
 
 
-    public async getSmartContractMEVRewards(params?: SmartContractsApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: GetSmartContractMEVRewards200Response, status: number }> {
+    public async getStakingVaultRewardsDaily(params?: LidoRewardsApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: ValidatorRewardsDailyResponse, status: number }> {
 
-        const localVarPath = this.basePath + '/smartContracts/{contractAddress}/MEVRewards'
-            .replace('{' + 'contractAddress' + '}', encodeURIComponent(String(params?.contractAddress)));
+        const localVarPath = this.basePath + '/lidov3/rewards/daily';
        
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -154,18 +160,11 @@ export class SmartContractsApi {
         let localVarFormParams: any = {};
 
 
-        // Verify required parameter 'contractAddress' is not null or undefined
-        if (params?.contractAddress === null || params?.contractAddress === undefined) {
-            throw new Error('Required parameter "contractAddress" was null or undefined when calling getSmartContractMEVRewards.');
-        }
 
 
 
-    if (params?.page !== undefined) {
-        localVarQueryParameters['page'] = ObjectSerializer.serialize(params?.page, "number");
-    }
-    if (params?.limit !== undefined) {
-        localVarQueryParameters['limit'] = ObjectSerializer.serialize(params?.limit, "number");
+    if (params?.contractsId !== undefined) {
+        localVarQueryParameters['contractsId'] = ObjectSerializer.serialize(params?.contractsId, "string");
     }
     if (params?.startDate !== undefined) {
         localVarQueryParameters['start_date'] = ObjectSerializer.serialize(params?.startDate, "Date");
@@ -173,6 +172,15 @@ export class SmartContractsApi {
     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");
+    }
+    if (params?.rewardType !== undefined) {
+        localVarQueryParameters['reward_type'] = ObjectSerializer.serialize(params?.rewardType, "'consensus' | 'block' | 'mev'");
+    }
 
 
 
@@ -208,14 +216,14 @@ export class SmartContractsApi {
                     localVarRequestOptions.form = localVarFormParams;
                 }
             }
-                 return new Promise<{ body: GetSmartContractMEVRewards200Response, status: number }>((resolve, reject) => {
+                 return new Promise<{ body: ValidatorRewardsDailyResponse, 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, "GetSmartContractMEVRewards200Response");
+                        body = ObjectSerializer.deserialize(body, "ValidatorRewardsDailyResponse");
                         resolve({ body: body, status: response.statusCode });
                     } else {
                         console.error('API response error:', response.statusCode);
@@ -227,23 +235,23 @@ export class SmartContractsApi {
     } )
 }
     /**
-     * 
-     * @summary Get mined blocks related to a specific smart contract
-     * @param contractAddress The address of the smart contract
+     * Retrieves a paginated list of raw validator reward records for all staking vaults. Optionally filter by a specific contractsId. Supports filtering by date range and reward type.
+     * @summary Get raw validator rewards for staking vaults
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, returns rewards for all staking vaults.
+     * @param startDate Start date for filtering rewards
+     * @param endDate End date for filtering rewards
      * @param page Page number for pagination
-     * @param limit Number of mined blocks per page
-     * @param startDate Start date for filtering mined blocks
-     * @param endDate End date for filtering mined blocks
+     * @param limit Number of reward records per page
+     * @param rewardType Filter by reward type
      */
 
    
 
 
 
-    public async getSmartContractMinedBlocks(params?: SmartContractsApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: GetSmartContractMinedBlocks200Response, status: number }> {
+    public async getStakingVaultRewardsRaw(params?: LidoRewardsApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: ValidatorRewardsRaw, status: number }> {
 
-        const localVarPath = this.basePath + '/smartContracts/{contractAddress}/minedBlocks'
-            .replace('{' + 'contractAddress' + '}', encodeURIComponent(String(params?.contractAddress)));
+        const localVarPath = this.basePath + '/lidov3/rewards/raw';
        
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -256,18 +264,11 @@ export class SmartContractsApi {
         let localVarFormParams: any = {};
 
 
-        // Verify required parameter 'contractAddress' is not null or undefined
-        if (params?.contractAddress === null || params?.contractAddress === undefined) {
-            throw new Error('Required parameter "contractAddress" was null or undefined when calling getSmartContractMinedBlocks.');
-        }
 
 
 
-    if (params?.page !== undefined) {
-        localVarQueryParameters['page'] = ObjectSerializer.serialize(params?.page, "number");
-    }
-    if (params?.limit !== undefined) {
-        localVarQueryParameters['limit'] = ObjectSerializer.serialize(params?.limit, "number");
+    if (params?.contractsId !== undefined) {
+        localVarQueryParameters['contractsId'] = ObjectSerializer.serialize(params?.contractsId, "string");
     }
     if (params?.startDate !== undefined) {
         localVarQueryParameters['start_date'] = ObjectSerializer.serialize(params?.startDate, "Date");
@@ -275,6 +276,15 @@ export class SmartContractsApi {
     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");
+    }
+    if (params?.rewardType !== undefined) {
+        localVarQueryParameters['reward_type'] = ObjectSerializer.serialize(params?.rewardType, "'consensus' | 'block' | 'mev'");
+    }
 
 
 
@@ -310,14 +320,14 @@ export class SmartContractsApi {
                     localVarRequestOptions.form = localVarFormParams;
                 }
             }
-                 return new Promise<{ body: GetSmartContractMinedBlocks200Response, status: number }>((resolve, reject) => {
+                 return new Promise<{ body: ValidatorRewardsRaw, 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, "GetSmartContractMinedBlocks200Response");
+                        body = ObjectSerializer.deserialize(body, "ValidatorRewardsRaw");
                         resolve({ body: body, status: response.statusCode });
                     } else {
                         console.error('API response error:', response.statusCode);
@@ -329,23 +339,21 @@ export class SmartContractsApi {
     } )
 }
     /**
-     * 
-     * @summary Get transactions related to a specific smart contract
-     * @param contractAddress The address of the smart contract
-     * @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
+     * Creates an internal order document for CSV export of daily aggregated rewards. The backend janitor will process this order and send the CSV via email.
+     * @summary Request CSV export for daily rewards
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, exports rewards for all staking vaults.
+     * @param startDate Start date for filtering rewards
+     * @param endDate End date for filtering rewards
+     * @param rewardType Filter by reward type
      */
 
    
 
 
 
-    public async getSmartContractTransactions(params?: SmartContractsApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: GetSmartContractTransactions200Response, status: number }> {
+    public async requestRewardsDailyCsvExport(params?: LidoRewardsApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: any, status: number }> {
 
-        const localVarPath = this.basePath + '/smartContracts/{contractAddress}/transactions'
-            .replace('{' + 'contractAddress' + '}', encodeURIComponent(String(params?.contractAddress)));
+        const localVarPath = this.basePath + '/lidov3/rewards/daily/csv-export';
        
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -358,24 +366,20 @@ export class SmartContractsApi {
         let localVarFormParams: any = {};
 
 
-        // Verify required parameter 'contractAddress' is not null or undefined
-        if (params?.contractAddress === null || params?.contractAddress === undefined) {
-            throw new Error('Required parameter "contractAddress" was null or undefined when calling getSmartContractTransactions.');
-        }
 
 
 
+    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");
+    if (params?.rewardType !== undefined) {
+        localVarQueryParameters['reward_type'] = ObjectSerializer.serialize(params?.rewardType, "'consensus' | 'block' | 'mev'");
     }
 
 
@@ -388,7 +392,7 @@ export class SmartContractsApi {
 
 
         let localVarRequestOptions: localVarRequest.Options = {
-            method: 'GET',
+            method: 'POST',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
@@ -412,14 +416,13 @@ export class SmartContractsApi {
                     localVarRequestOptions.form = localVarFormParams;
                 }
             }
-                 return new Promise<{ body: GetSmartContractTransactions200Response, status: number }>((resolve, reject) => {
+                 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) {
-                        body = ObjectSerializer.deserialize(body, "GetSmartContractTransactions200Response");
                         resolve({ body: body, status: response.statusCode });
                     } else {
                         console.error('API response error:', response.statusCode);
@@ -431,17 +434,21 @@ export class SmartContractsApi {
     } )
 }
     /**
-     * 
-     * @summary Get list of all deployed smart contracts
+     * Creates an internal order document for CSV export of raw validator rewards. The backend janitor will process this order and send the CSV via email.
+     * @summary Request CSV export for raw rewards
+     * @param contractsId Optional filter by the unique identifier of a specific Lido staking contracts set. If not provided, exports rewards for all staking vaults.
+     * @param startDate Start date for filtering rewards
+     * @param endDate End date for filtering rewards
+     * @param rewardType Filter by reward type
      */
 
    
 
 
 
-   public async getSmartContracts (options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ body: Array<SmartContractDetailed>, status: number }> {
+    public async requestRewardsRawCsvExport(params?: LidoRewardsApiParams, options: { headers: { [name: string]: string } } = { headers: {} }): Promise<{ body: any, status: number }> {
 
-        const localVarPath = this.basePath + '/smartContracts';
+        const localVarPath = this.basePath + '/lidov3/rewards/raw/csv-export';
        
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -457,6 +464,18 @@ export class SmartContractsApi {
 
 
 
+    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?.rewardType !== undefined) {
+        localVarQueryParameters['reward_type'] = ObjectSerializer.serialize(params?.rewardType, "'consensus' | 'block' | 'mev'");
+    }
 
 
 
@@ -468,7 +487,7 @@ export class SmartContractsApi {
 
 
         let localVarRequestOptions: localVarRequest.Options = {
-            method: 'GET',
+            method: 'POST',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
@@ -492,14 +511,13 @@ export class SmartContractsApi {
                     localVarRequestOptions.form = localVarFormParams;
                 }
             }
-                 return new Promise<{ body: Array<SmartContractDetailed>, status: number }>((resolve, reject) => {
+                 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) {
-                        body = ObjectSerializer.deserialize(body, "Array<SmartContractDetailed>");
                         resolve({ body: body, status: response.statusCode });
                     } else {
                         console.error('API response error:', response.statusCode);