zklighter-perps 1.0.294 → 1.0.296

package/.circleci/openapi_postprocess.py

@@ -285,6 +285,8 @@ for definition_name, property_names in nullable_properties.items():
 # These fields use `omitempty` in server.api and are absent when FMP has no
 # value. They are optional rather than nullable in the generated SDK.
 optional_properties = {
+    "RespStockFinancials": {"stock_financials"},
+    "StockFinancialEarnings": {"history"},
     "StockFinancialEarningsEvent": {"timing"},
     "StockFinancialPeriod": {"reported_currency"},
     "StockFinancialProfile": {
@@ -294,6 +296,8 @@ optional_properties = {
         "sector",
         "country",
     },
+    "StockFinancialStatements": {"annual", "quarterly"},
+    "Token": {"backend_symbol"},
     "UpcomingEarning": {"currency", "timing"},
 }
 

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>;
 }
 
 /**
@@ -68,6 +74,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'] == null ? undefined : ((json['stock_financials'] as Array<any>).map(StockFinancialFromJSON)),
     };
 }
 
@@ -80,6 +87,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'] == null ? undefined : ((value['stock_financials'] as Array<any>).map(StockFinancialToJSON)),
     };
 }
 

package/models/StockFinancialEarnings.ts

@@ -43,14 +43,13 @@ export interface StockFinancialEarnings {
      * @type {Array<StockFinancialHistoricalEarning>}
      * @memberof StockFinancialEarnings
      */
-    history: Array<StockFinancialHistoricalEarning>;
+    history?: Array<StockFinancialHistoricalEarning>;
 }
 
 /**
  * Check if a given object implements the StockFinancialEarnings interface.
  */
 export function instanceOfStockFinancialEarnings(value: object): value is StockFinancialEarnings {
-    if (!('history' in value) || value['history'] === undefined) return false;
     return true;
 }
 
@@ -65,7 +64,7 @@ export function StockFinancialEarningsFromJSONTyped(json: any, ignoreDiscriminat
     return {
         
         'next': json['next'] == null ? undefined : StockFinancialEarningsEventFromJSON(json['next']),
-        'history': ((json['history'] as Array<any>).map(StockFinancialHistoricalEarningFromJSON)),
+        'history': json['history'] == null ? undefined : ((json['history'] as Array<any>).map(StockFinancialHistoricalEarningFromJSON)),
     };
 }
 
@@ -76,7 +75,7 @@ export function StockFinancialEarningsToJSON(value?: StockFinancialEarnings | nu
     return {
         
         'next': StockFinancialEarningsEventToJSON(value['next']),
-        'history': ((value['history'] as Array<any>).map(StockFinancialHistoricalEarningToJSON)),
+        'history': value['history'] == null ? undefined : ((value['history'] as Array<any>).map(StockFinancialHistoricalEarningToJSON)),
     };
 }
 

package/models/StockFinancialStatements.ts

@@ -31,21 +31,19 @@ export interface StockFinancialStatements {
      * @type {Array<StockFinancialPeriod>}
      * @memberof StockFinancialStatements
      */
-    annual: Array<StockFinancialPeriod>;
+    annual?: Array<StockFinancialPeriod>;
     /**
      * 
      * @type {Array<StockFinancialPeriod>}
      * @memberof StockFinancialStatements
      */
-    quarterly: Array<StockFinancialPeriod>;
+    quarterly?: Array<StockFinancialPeriod>;
 }
 
 /**
  * Check if a given object implements the StockFinancialStatements interface.
  */
 export function instanceOfStockFinancialStatements(value: object): value is StockFinancialStatements {
-    if (!('annual' in value) || value['annual'] === undefined) return false;
-    if (!('quarterly' in value) || value['quarterly'] === undefined) return false;
     return true;
 }
 
@@ -59,8 +57,8 @@ export function StockFinancialStatementsFromJSONTyped(json: any, ignoreDiscrimin
     }
     return {
         
-        'annual': ((json['annual'] as Array<any>).map(StockFinancialPeriodFromJSON)),
-        'quarterly': ((json['quarterly'] as Array<any>).map(StockFinancialPeriodFromJSON)),
+        'annual': json['annual'] == null ? undefined : ((json['annual'] as Array<any>).map(StockFinancialPeriodFromJSON)),
+        'quarterly': json['quarterly'] == null ? undefined : ((json['quarterly'] as Array<any>).map(StockFinancialPeriodFromJSON)),
     };
 }
 
@@ -70,8 +68,8 @@ export function StockFinancialStatementsToJSON(value?: StockFinancialStatements
     }
     return {
         
-        'annual': ((value['annual'] as Array<any>).map(StockFinancialPeriodToJSON)),
-        'quarterly': ((value['quarterly'] as Array<any>).map(StockFinancialPeriodToJSON)),
+        'annual': value['annual'] == null ? undefined : ((value['annual'] as Array<any>).map(StockFinancialPeriodToJSON)),
+        'quarterly': value['quarterly'] == null ? undefined : ((value['quarterly'] as Array<any>).map(StockFinancialPeriodToJSON)),
     };
 }
 

package/models/Token.ts

@@ -30,7 +30,7 @@ export interface Token {
      * @type {string}
      * @memberof Token
      */
-    backend_symbol: string;
+    backend_symbol?: string;
     /**
      * 
      * @type {string}
@@ -139,7 +139,6 @@ export type TokenAssetTypeEnum = typeof TokenAssetTypeEnum[keyof typeof TokenAss
  */
 export function instanceOfToken(value: object): value is Token {
     if (!('symbol' in value) || value['symbol'] === undefined) return false;
-    if (!('backend_symbol' in value) || value['backend_symbol'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('logo' in value) || value['logo'] === undefined) return false;
     if (!('logo_extension' in value) || value['logo_extension'] === undefined) return false;
@@ -166,7 +165,7 @@ export function TokenFromJSONTyped(json: any, ignoreDiscriminator: boolean): Tok
     return {
         
         'symbol': json['symbol'],
-        'backend_symbol': json['backend_symbol'],
+        'backend_symbol': json['backend_symbol'] == null ? undefined : json['backend_symbol'],
         'name': json['name'],
         'logo': json['logo'],
         'logo_extension': json['logo_extension'],

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,6 +14264,12 @@
         },
         "stock_financial": {
           "$ref": "#/definitions/StockFinancial"
+        },
+        "stock_financials": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/StockFinancial"
+          }
         }
       },
       "title": "RespStockFinancials",
@@ -15070,10 +15084,7 @@
           }
         }
       },
-      "title": "StockFinancialEarnings",
-      "required": [
-        "history"
-      ]
+      "title": "StockFinancialEarnings"
     },
     "StockFinancialEarningsEvent": {
       "type": "object",
@@ -15223,11 +15234,7 @@
           }
         }
       },
-      "title": "StockFinancialStatements",
-      "required": [
-        "annual",
-        "quarterly"
-      ]
+      "title": "StockFinancialStatements"
     },
     "StockIncomeStatement": {
       "type": "object",
@@ -15521,7 +15528,6 @@
       "title": "Token",
       "required": [
         "symbol",
-        "backend_symbol",
         "name",
         "logo",
         "logo_extension",

package/package.json

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