zklighter-perps 1.0.294 → 1.0.295

package/apis/StockfinancialsApi.ts

@@ -26,7 +26,8 @@ import {
 } from '../models/index';
 
 export interface StockFinancialsRequest {
-    market_id: number;
+    market_id?: number;
+    fields?: string;
 }
 
 /**
@@ -35,23 +36,20 @@ export interface StockFinancialsRequest {
 export class StockfinancialsApi extends runtime.BaseAPI {
 
     /**
-     * Get stock financials
+     * Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings; omit it to get the full record, which requires market_id.
      * stockFinancials
      */
     async stockFinancialsRaw(requestParameters: StockFinancialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespStockFinancials>> {
-        if (requestParameters['market_id'] == null) {
-            throw new runtime.RequiredError(
-                'market_id',
-                'Required parameter "market_id" was null or undefined when calling stockFinancials().'
-            );
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters['market_id'] != null) {
             queryParameters['market_id'] = requestParameters['market_id'];
         }
 
+        if (requestParameters['fields'] != null) {
+            queryParameters['fields'] = requestParameters['fields'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
@@ -65,10 +63,10 @@ export class StockfinancialsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get stock financials
+     * Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings; omit it to get the full record, which requires market_id.
      * stockFinancials
      */
-    async stockFinancials(requestParameters: StockFinancialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespStockFinancials> {
+    async stockFinancials(requestParameters: StockFinancialsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespStockFinancials> {
         const response = await this.stockFinancialsRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/models/ReqGetStockFinancials.ts

@@ -24,14 +24,19 @@ export interface ReqGetStockFinancials {
      * @type {number}
      * @memberof ReqGetStockFinancials
      */
-    market_id: number;
+    market_id?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetStockFinancials
+     */
+    fields?: string;
 }
 
 /**
  * Check if a given object implements the ReqGetStockFinancials interface.
  */
 export function instanceOfReqGetStockFinancials(value: object): value is ReqGetStockFinancials {
-    if (!('market_id' in value) || value['market_id'] === undefined) return false;
     return true;
 }
 
@@ -45,7 +50,8 @@ export function ReqGetStockFinancialsFromJSONTyped(json: any, ignoreDiscriminato
     }
     return {
         
-        'market_id': json['market_id'],
+        'market_id': json['market_id'] == null ? undefined : json['market_id'],
+        'fields': json['fields'] == null ? undefined : json['fields'],
     };
 }
 
@@ -56,6 +62,7 @@ export function ReqGetStockFinancialsToJSON(value?: ReqGetStockFinancials | null
     return {
         
         'market_id': value['market_id'],
+        'fields': value['fields'],
     };
 }
 

package/models/RespStockFinancials.ts

@@ -44,6 +44,12 @@ export interface RespStockFinancials {
      * @memberof RespStockFinancials
      */
     stock_financial: StockFinancial;
+    /**
+     * 
+     * @type {Array<StockFinancial>}
+     * @memberof RespStockFinancials
+     */
+    stock_financials: Array<StockFinancial>;
 }
 
 /**
@@ -52,6 +58,7 @@ export interface RespStockFinancials {
 export function instanceOfRespStockFinancials(value: object): value is RespStockFinancials {
     if (!('code' in value) || value['code'] === undefined) return false;
     if (!('stock_financial' in value) || value['stock_financial'] === undefined) return false;
+    if (!('stock_financials' in value) || value['stock_financials'] === undefined) return false;
     return true;
 }
 
@@ -68,6 +75,7 @@ export function RespStockFinancialsFromJSONTyped(json: any, ignoreDiscriminator:
         'code': json['code'],
         'message': json['message'] == null ? undefined : json['message'],
         'stock_financial': StockFinancialFromJSON(json['stock_financial']),
+        'stock_financials': ((json['stock_financials'] as Array<any>).map(StockFinancialFromJSON)),
     };
 }
 
@@ -80,6 +88,7 @@ export function RespStockFinancialsToJSON(value?: RespStockFinancials | null): a
         'code': value['code'],
         'message': value['message'],
         'stock_financial': StockFinancialToJSON(value['stock_financial']),
+        'stock_financials': ((value['stock_financials'] as Array<any>).map(StockFinancialToJSON)),
     };
 }
 

package/openapi.json

@@ -4627,9 +4627,16 @@
           {
             "name": "market_id",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "integer",
-            "format": "int16"
+            "format": "int16",
+            "default": "-1"
+          },
+          {
+            "name": "fields",
+            "in": "query",
+            "required": false,
+            "type": "string"
           }
         ],
         "tags": [
@@ -4638,7 +4645,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get stock financials"
+        "description": "Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings; omit it to get the full record, which requires market_id."
       }
     },
     "/api/v1/syntheticSpotInfo": {
@@ -12591,13 +12598,14 @@
       "properties": {
         "market_id": {
           "type": "integer",
-          "format": "int16"
+          "format": "int16",
+          "default": "-1"
+        },
+        "fields": {
+          "type": "string"
         }
       },
-      "title": "ReqGetStockFinancials",
-      "required": [
-        "market_id"
-      ]
+      "title": "ReqGetStockFinancials"
     },
     "ReqGetSyntheticSpotInfo": {
       "type": "object",
@@ -14256,12 +14264,19 @@
         },
         "stock_financial": {
           "$ref": "#/definitions/StockFinancial"
+        },
+        "stock_financials": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/StockFinancial"
+          }
         }
       },
       "title": "RespStockFinancials",
       "required": [
         "code",
-        "stock_financial"
+        "stock_financial",
+        "stock_financials"
       ]
     },
     "RespSyntheticSpotInfo": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.294",
+  "version": "1.0.295",
   "description": "Lighter Perps SDK",
   "main": "index.ts",
   "directories": {