zklighter-perps 1.0.29 → 1.0.31

package/apis/AccountApi.ts

@@ -19,7 +19,6 @@ import type {
   AccountPnL,
   Accounts,
   DetailedAccounts,
-  Permission,
   ResultCode,
   SubAccounts,
 } from '../models/index';
@@ -32,51 +31,43 @@ import {
     AccountsToJSON,
     DetailedAccountsFromJSON,
     DetailedAccountsToJSON,
-    PermissionFromJSON,
-    PermissionToJSON,
     ResultCodeFromJSON,
     ResultCodeToJSON,
     SubAccountsFromJSON,
     SubAccountsToJSON,
 } from '../models/index';
 
-export interface DoFaucetRequest {
-    l1_address: string;
-}
-
-export interface GetAccountRequest {
-    by: GetAccountByEnum;
+export interface AccountRequest {
+    by: AccountByEnum;
     value: string;
 }
 
-export interface GetAccountApiKeysRequest {
-    account_index: number;
-    api_key_index: number;
+export interface AccountsRequest {
+    limit: number;
+    index?: number;
+    sort?: AccountsSortEnum;
 }
 
-export interface GetAccountPnlRequest {
-    by: GetAccountPnlByEnum;
-    value: string;
-    resolution: GetAccountPnlResolutionEnum;
-    start_timestamp: number;
-    end_timestamp: number;
-    count_back: number;
+export interface AccountsByL1AddressRequest {
+    l1_address: string;
 }
 
-export interface GetAccountsRequest {
-    limit: number;
-    index?: number;
-    sort?: GetAccountsSortEnum;
+export interface ApikeysRequest {
+    account_index: number;
+    api_key_index: number;
 }
 
-export interface GetAccountsByL1AddressRequest {
+export interface FaucetRequest {
     l1_address: string;
 }
 
-export interface GetPermissionRequest {
-    by: GetPermissionByEnum;
+export interface PnlRequest {
+    by: PnlByEnum;
     value: string;
-    tx_type: number;
+    resolution: PnlResolutionEnum;
+    start_timestamp: number;
+    end_timestamp: number;
+    count_back: number;
 }
 
 /**
@@ -85,60 +76,21 @@ export interface GetPermissionRequest {
 export class AccountApi extends runtime.BaseAPI {
 
     /**
-     * Request funds from faucet
-     * DoFaucet
+     * Get account by account\'s index. <br>More details about account index: [Account Index](https://apidocs.lighter.xyz/docs/account-index)<hr>**Response Description:**<br><br>1) **Status:** 1 is active 0 is inactive.<br>2) **Collateral:** The amount of collateral in the account.<hr>**Position Details Description:**<br>1) **OOC:** Open order count in that market.<br>2) **Sign:** 1 for Long, -1 for Short.<br>3) **Position:** The amount of position in that market.<br>4) **Avg Entry Price:** The average entry price of the position.<br>5) **Position Value:** The value of the position.<br>6) **Unrealized PnL:** The unrealized profit and loss of the position.<br>7) **Realized PnL:** The realized profit and loss of the position.
+     * account
      */
-    async doFaucetRaw(requestParameters: DoFaucetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
-        if (requestParameters['l1_address'] == null) {
-            throw new runtime.RequiredError(
-                'l1_address',
-                'Required parameter "l1_address" was null or undefined when calling doFaucet().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters['l1_address'] != null) {
-            queryParameters['l1_address'] = requestParameters['l1_address'];
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        const response = await this.request({
-            path: `/api/v1/faucet`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
-    }
-
-    /**
-     * Request funds from faucet
-     * DoFaucet
-     */
-    async doFaucet(requestParameters: DoFaucetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
-        const response = await this.doFaucetRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Get account by account\'s l1_address or index. Returns detailed account info
-     * GetAccount
-     */
-    async getAccountRaw(requestParameters: GetAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DetailedAccounts>> {
+    async accountRaw(requestParameters: AccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DetailedAccounts>> {
         if (requestParameters['by'] == null) {
             throw new runtime.RequiredError(
                 'by',
-                'Required parameter "by" was null or undefined when calling getAccount().'
+                'Required parameter "by" was null or undefined when calling account().'
             );
         }
 
         if (requestParameters['value'] == null) {
             throw new runtime.RequiredError(
                 'value',
-                'Required parameter "value" was null or undefined when calling getAccount().'
+                'Required parameter "value" was null or undefined when calling account().'
             );
         }
 
@@ -165,214 +117,159 @@ export class AccountApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get account by account\'s l1_address or index. Returns detailed account info
-     * GetAccount
+     * Get account by account\'s index. <br>More details about account index: [Account Index](https://apidocs.lighter.xyz/docs/account-index)<hr>**Response Description:**<br><br>1) **Status:** 1 is active 0 is inactive.<br>2) **Collateral:** The amount of collateral in the account.<hr>**Position Details Description:**<br>1) **OOC:** Open order count in that market.<br>2) **Sign:** 1 for Long, -1 for Short.<br>3) **Position:** The amount of position in that market.<br>4) **Avg Entry Price:** The average entry price of the position.<br>5) **Position Value:** The value of the position.<br>6) **Unrealized PnL:** The unrealized profit and loss of the position.<br>7) **Realized PnL:** The realized profit and loss of the position.
+     * account
      */
-    async getAccount(requestParameters: GetAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DetailedAccounts> {
-        const response = await this.getAccountRaw(requestParameters, initOverrides);
+    async account(requestParameters: AccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DetailedAccounts> {
+        const response = await this.accountRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Get account api key
-     * GetAccountApiKeys
+     * Get accounts returns accounts by account index
+     * accounts
      */
-    async getAccountApiKeysRaw(requestParameters: GetAccountApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountApiKeys>> {
-        if (requestParameters['account_index'] == null) {
-            throw new runtime.RequiredError(
-                'account_index',
-                'Required parameter "account_index" was null or undefined when calling getAccountApiKeys().'
-            );
-        }
-
-        if (requestParameters['api_key_index'] == null) {
+    async accountsRaw(requestParameters: AccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Accounts>> {
+        if (requestParameters['limit'] == null) {
             throw new runtime.RequiredError(
-                'api_key_index',
-                'Required parameter "api_key_index" was null or undefined when calling getAccountApiKeys().'
+                'limit',
+                'Required parameter "limit" was null or undefined when calling accounts().'
             );
         }
 
         const queryParameters: any = {};
 
-        if (requestParameters['account_index'] != null) {
-            queryParameters['account_index'] = requestParameters['account_index'];
+        if (requestParameters['index'] != null) {
+            queryParameters['index'] = requestParameters['index'];
         }
 
-        if (requestParameters['api_key_index'] != null) {
-            queryParameters['api_key_index'] = requestParameters['api_key_index'];
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
         }
 
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
-            path: `/api/v1/apikeys`,
+            path: `/api/v1/accounts`,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => AccountApiKeysFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountsFromJSON(jsonValue));
     }
 
     /**
-     * Get account api key
-     * GetAccountApiKeys
+     * Get accounts returns accounts by account index
+     * accounts
      */
-    async getAccountApiKeys(requestParameters: GetAccountApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountApiKeys> {
-        const response = await this.getAccountApiKeysRaw(requestParameters, initOverrides);
+    async accounts(requestParameters: AccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Accounts> {
+        const response = await this.accountsRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Get account PnL chart
-     * GetAccountPnl
+     * Get accounts by l1_address returns all accounts associated with the given L1 address
+     * accountsByL1Address
      */
-    async getAccountPnlRaw(requestParameters: GetAccountPnlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountPnL>> {
-        if (requestParameters['by'] == null) {
-            throw new runtime.RequiredError(
-                'by',
-                'Required parameter "by" was null or undefined when calling getAccountPnl().'
-            );
-        }
-
-        if (requestParameters['value'] == null) {
-            throw new runtime.RequiredError(
-                'value',
-                'Required parameter "value" was null or undefined when calling getAccountPnl().'
-            );
-        }
-
-        if (requestParameters['resolution'] == null) {
-            throw new runtime.RequiredError(
-                'resolution',
-                'Required parameter "resolution" was null or undefined when calling getAccountPnl().'
-            );
-        }
-
-        if (requestParameters['start_timestamp'] == null) {
-            throw new runtime.RequiredError(
-                'start_timestamp',
-                'Required parameter "start_timestamp" was null or undefined when calling getAccountPnl().'
-            );
-        }
-
-        if (requestParameters['end_timestamp'] == null) {
-            throw new runtime.RequiredError(
-                'end_timestamp',
-                'Required parameter "end_timestamp" was null or undefined when calling getAccountPnl().'
-            );
-        }
-
-        if (requestParameters['count_back'] == null) {
+    async accountsByL1AddressRaw(requestParameters: AccountsByL1AddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubAccounts>> {
+        if (requestParameters['l1_address'] == null) {
             throw new runtime.RequiredError(
-                'count_back',
-                'Required parameter "count_back" was null or undefined when calling getAccountPnl().'
+                'l1_address',
+                'Required parameter "l1_address" was null or undefined when calling accountsByL1Address().'
             );
         }
 
         const queryParameters: any = {};
 
-        if (requestParameters['by'] != null) {
-            queryParameters['by'] = requestParameters['by'];
-        }
-
-        if (requestParameters['value'] != null) {
-            queryParameters['value'] = requestParameters['value'];
-        }
-
-        if (requestParameters['resolution'] != null) {
-            queryParameters['resolution'] = requestParameters['resolution'];
-        }
-
-        if (requestParameters['start_timestamp'] != null) {
-            queryParameters['start_timestamp'] = requestParameters['start_timestamp'];
-        }
-
-        if (requestParameters['end_timestamp'] != null) {
-            queryParameters['end_timestamp'] = requestParameters['end_timestamp'];
-        }
-
-        if (requestParameters['count_back'] != null) {
-            queryParameters['count_back'] = requestParameters['count_back'];
+        if (requestParameters['l1_address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1_address'];
         }
 
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
-            path: `/api/v1/pnl`,
+            path: `/api/v1/accountsByL1Address`,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => AccountPnLFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => SubAccountsFromJSON(jsonValue));
     }
 
     /**
-     * Get account PnL chart
-     * GetAccountPnl
+     * Get accounts by l1_address returns all accounts associated with the given L1 address
+     * accountsByL1Address
      */
-    async getAccountPnl(requestParameters: GetAccountPnlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountPnL> {
-        const response = await this.getAccountPnlRaw(requestParameters, initOverrides);
+    async accountsByL1Address(requestParameters: AccountsByL1AddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubAccounts> {
+        const response = await this.accountsByL1AddressRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Get accounts returns accounts by account index
-     * GetAccounts
+     * Get account api key
+     * apikeys
      */
-    async getAccountsRaw(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Accounts>> {
-        if (requestParameters['limit'] == null) {
+    async apikeysRaw(requestParameters: ApikeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountApiKeys>> {
+        if (requestParameters['account_index'] == null) {
             throw new runtime.RequiredError(
-                'limit',
-                'Required parameter "limit" was null or undefined when calling getAccounts().'
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling apikeys().'
             );
         }
 
-        const queryParameters: any = {};
-
-        if (requestParameters['index'] != null) {
-            queryParameters['index'] = requestParameters['index'];
+        if (requestParameters['api_key_index'] == null) {
+            throw new runtime.RequiredError(
+                'api_key_index',
+                'Required parameter "api_key_index" was null or undefined when calling apikeys().'
+            );
         }
 
-        if (requestParameters['limit'] != null) {
-            queryParameters['limit'] = requestParameters['limit'];
+        const queryParameters: any = {};
+
+        if (requestParameters['account_index'] != null) {
+            queryParameters['account_index'] = requestParameters['account_index'];
         }
 
-        if (requestParameters['sort'] != null) {
-            queryParameters['sort'] = requestParameters['sort'];
+        if (requestParameters['api_key_index'] != null) {
+            queryParameters['api_key_index'] = requestParameters['api_key_index'];
         }
 
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
-            path: `/api/v1/accounts`,
+            path: `/api/v1/apikeys`,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => AccountsFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountApiKeysFromJSON(jsonValue));
     }
 
     /**
-     * Get accounts returns accounts by account index
-     * GetAccounts
+     * Get account api key
+     * apikeys
      */
-    async getAccounts(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Accounts> {
-        const response = await this.getAccountsRaw(requestParameters, initOverrides);
+    async apikeys(requestParameters: ApikeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountApiKeys> {
+        const response = await this.apikeysRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Get accounts by l1_address returns all accounts associated with the given L1 address
-     * GetAccountsByL1Address
+     * Request funds from faucet
+     * faucet
      */
-    async getAccountsByL1AddressRaw(requestParameters: GetAccountsByL1AddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubAccounts>> {
+    async faucetRaw(requestParameters: FaucetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
         if (requestParameters['l1_address'] == null) {
             throw new runtime.RequiredError(
                 'l1_address',
-                'Required parameter "l1_address" was null or undefined when calling getAccountsByL1Address().'
+                'Required parameter "l1_address" was null or undefined when calling faucet().'
             );
         }
 
@@ -385,47 +282,68 @@ export class AccountApi extends runtime.BaseAPI {
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
-            path: `/api/v1/accountsByL1Address`,
+            path: `/api/v1/faucet`,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => SubAccountsFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
     }
 
     /**
-     * Get accounts by l1_address returns all accounts associated with the given L1 address
-     * GetAccountsByL1Address
+     * Request funds from faucet
+     * faucet
      */
-    async getAccountsByL1Address(requestParameters: GetAccountsByL1AddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubAccounts> {
-        const response = await this.getAccountsByL1AddressRaw(requestParameters, initOverrides);
+    async faucet(requestParameters: FaucetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.faucetRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Get permission by account\'s l1_address, index and tx_type
-     * GetPermission
+     * Get account PnL chart
+     * pnl
      */
-    async getPermissionRaw(requestParameters: GetPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Permission>> {
+    async pnlRaw(requestParameters: PnlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountPnL>> {
         if (requestParameters['by'] == null) {
             throw new runtime.RequiredError(
                 'by',
-                'Required parameter "by" was null or undefined when calling getPermission().'
+                'Required parameter "by" was null or undefined when calling pnl().'
             );
         }
 
         if (requestParameters['value'] == null) {
             throw new runtime.RequiredError(
                 'value',
-                'Required parameter "value" was null or undefined when calling getPermission().'
+                'Required parameter "value" was null or undefined when calling pnl().'
+            );
+        }
+
+        if (requestParameters['resolution'] == null) {
+            throw new runtime.RequiredError(
+                'resolution',
+                'Required parameter "resolution" was null or undefined when calling pnl().'
+            );
+        }
+
+        if (requestParameters['start_timestamp'] == null) {
+            throw new runtime.RequiredError(
+                'start_timestamp',
+                'Required parameter "start_timestamp" was null or undefined when calling pnl().'
             );
         }
 
-        if (requestParameters['tx_type'] == null) {
+        if (requestParameters['end_timestamp'] == null) {
             throw new runtime.RequiredError(
-                'tx_type',
-                'Required parameter "tx_type" was null or undefined when calling getPermission().'
+                'end_timestamp',
+                'Required parameter "end_timestamp" was null or undefined when calling pnl().'
+            );
+        }
+
+        if (requestParameters['count_back'] == null) {
+            throw new runtime.RequiredError(
+                'count_back',
+                'Required parameter "count_back" was null or undefined when calling pnl().'
             );
         }
 
@@ -439,28 +357,40 @@ export class AccountApi extends runtime.BaseAPI {
             queryParameters['value'] = requestParameters['value'];
         }
 
-        if (requestParameters['tx_type'] != null) {
-            queryParameters['tx_type'] = requestParameters['tx_type'];
+        if (requestParameters['resolution'] != null) {
+            queryParameters['resolution'] = requestParameters['resolution'];
+        }
+
+        if (requestParameters['start_timestamp'] != null) {
+            queryParameters['start_timestamp'] = requestParameters['start_timestamp'];
+        }
+
+        if (requestParameters['end_timestamp'] != null) {
+            queryParameters['end_timestamp'] = requestParameters['end_timestamp'];
+        }
+
+        if (requestParameters['count_back'] != null) {
+            queryParameters['count_back'] = requestParameters['count_back'];
         }
 
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
-            path: `/api/v1/permission`,
+            path: `/api/v1/pnl`,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => PermissionFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountPnLFromJSON(jsonValue));
     }
 
     /**
-     * Get permission by account\'s l1_address, index and tx_type
-     * GetPermission
+     * Get account PnL chart
+     * pnl
      */
-    async getPermission(requestParameters: GetPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Permission> {
-        const response = await this.getPermissionRaw(requestParameters, initOverrides);
+    async pnl(requestParameters: PnlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountPnL> {
+        const response = await this.pnlRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
@@ -469,22 +399,30 @@ export class AccountApi extends runtime.BaseAPI {
 /**
  * @export
  */
-export const GetAccountByEnum = {
+export const AccountByEnum = {
     Index: 'index',
     L1Address: 'l1_address'
 } as const;
-export type GetAccountByEnum = typeof GetAccountByEnum[keyof typeof GetAccountByEnum];
+export type AccountByEnum = typeof AccountByEnum[keyof typeof AccountByEnum];
+/**
+ * @export
+ */
+export const AccountsSortEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type AccountsSortEnum = typeof AccountsSortEnum[keyof typeof AccountsSortEnum];
 /**
  * @export
  */
-export const GetAccountPnlByEnum = {
+export const PnlByEnum = {
     Index: 'index'
 } as const;
-export type GetAccountPnlByEnum = typeof GetAccountPnlByEnum[keyof typeof GetAccountPnlByEnum];
+export type PnlByEnum = typeof PnlByEnum[keyof typeof PnlByEnum];
 /**
  * @export
  */
-export const GetAccountPnlResolutionEnum = {
+export const PnlResolutionEnum = {
     _1m: '1m',
     _5m: '5m',
     _15m: '15m',
@@ -492,20 +430,4 @@ export const GetAccountPnlResolutionEnum = {
     _4h: '4h',
     _1d: '1d'
 } as const;
-export type GetAccountPnlResolutionEnum = typeof GetAccountPnlResolutionEnum[keyof typeof GetAccountPnlResolutionEnum];
-/**
- * @export
- */
-export const GetAccountsSortEnum = {
-    Asc: 'asc',
-    Desc: 'desc'
-} as const;
-export type GetAccountsSortEnum = typeof GetAccountsSortEnum[keyof typeof GetAccountsSortEnum];
-/**
- * @export
- */
-export const GetPermissionByEnum = {
-    Index: 'index',
-    L1Address: 'l1_address'
-} as const;
-export type GetPermissionByEnum = typeof GetPermissionByEnum[keyof typeof GetPermissionByEnum];
+export type PnlResolutionEnum = typeof PnlResolutionEnum[keyof typeof PnlResolutionEnum];