zklighter-perps 1.0.319 → 1.0.321

package/.openapi-generator/FILES

@@ -21,6 +21,7 @@ apis/PushnotifApi.ts
 apis/ReferralApi.ts
 apis/RootApi.ts
 apis/StockfinancialsApi.ts
+apis/StrategyApi.ts
 apis/TokenlistApi.ts
 apis/TransactionApi.ts
 apis/TvApi.ts
@@ -251,6 +252,7 @@ models/RespAtomicOrderList.ts
 models/RespChangeAccountTier.ts
 models/RespCreateEvent.ts
 models/RespCreateRFQ.ts
+models/RespCreateStrategyHeartbeat.ts
 models/RespGaslessDeposit.ts
 models/RespGetApiTokens.ts
 models/RespGetBoPnL.ts

package/apis/StrategyApi.ts

@@ -0,0 +1,251 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  RespCreateStrategyHeartbeat,
+  ResultCode,
+} from '../models/index';
+import {
+    RespCreateStrategyHeartbeatFromJSON,
+    RespCreateStrategyHeartbeatToJSON,
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+} from '../models/index';
+
+export interface StrategyHeartbeatRequest {
+    account_index: number;
+    auth?: string;
+    strategy_type?: string;
+}
+
+export interface StrategyHeartbeatFinishRequest {
+    account_index: number;
+    heartbeat_id: string;
+    auth?: string;
+}
+
+export interface StrategyHeartbeatPingRequest {
+    account_index: number;
+    heartbeat_id: string;
+    auth?: string;
+}
+
+/**
+ * 
+ */
+export class StrategyApi extends runtime.BaseAPI {
+
+    /**
+     * Start a strategy heartbeat session
+     * strategy_heartbeat
+     */
+    async strategyHeartbeatRaw(requestParameters: StrategyHeartbeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespCreateStrategyHeartbeat>> {
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling strategyHeartbeat().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['auth'] != null) {
+            formParams.append('auth', requestParameters['auth'] as any);
+        }
+
+        if (requestParameters['account_index'] != null) {
+            formParams.append('account_index', requestParameters['account_index'] as any);
+        }
+
+        if (requestParameters['strategy_type'] != null) {
+            formParams.append('strategy_type', requestParameters['strategy_type'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/strategy/heartbeat`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespCreateStrategyHeartbeatFromJSON(jsonValue));
+    }
+
+    /**
+     * Start a strategy heartbeat session
+     * strategy_heartbeat
+     */
+    async strategyHeartbeat(requestParameters: StrategyHeartbeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespCreateStrategyHeartbeat> {
+        const response = await this.strategyHeartbeatRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Finish a strategy heartbeat session
+     * strategy_heartbeat_finish
+     */
+    async strategyHeartbeatFinishRaw(requestParameters: StrategyHeartbeatFinishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling strategyHeartbeatFinish().'
+            );
+        }
+
+        if (requestParameters['heartbeat_id'] == null) {
+            throw new runtime.RequiredError(
+                'heartbeat_id',
+                'Required parameter "heartbeat_id" was null or undefined when calling strategyHeartbeatFinish().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['auth'] != null) {
+            formParams.append('auth', requestParameters['auth'] as any);
+        }
+
+        if (requestParameters['account_index'] != null) {
+            formParams.append('account_index', requestParameters['account_index'] as any);
+        }
+
+        if (requestParameters['heartbeat_id'] != null) {
+            formParams.append('heartbeat_id', requestParameters['heartbeat_id'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/strategy/heartbeat/finish`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Finish a strategy heartbeat session
+     * strategy_heartbeat_finish
+     */
+    async strategyHeartbeatFinish(requestParameters: StrategyHeartbeatFinishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.strategyHeartbeatFinishRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Keep a strategy heartbeat session alive
+     * strategy_heartbeat_ping
+     */
+    async strategyHeartbeatPingRaw(requestParameters: StrategyHeartbeatPingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling strategyHeartbeatPing().'
+            );
+        }
+
+        if (requestParameters['heartbeat_id'] == null) {
+            throw new runtime.RequiredError(
+                'heartbeat_id',
+                'Required parameter "heartbeat_id" was null or undefined when calling strategyHeartbeatPing().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['auth'] != null) {
+            formParams.append('auth', requestParameters['auth'] as any);
+        }
+
+        if (requestParameters['account_index'] != null) {
+            formParams.append('account_index', requestParameters['account_index'] as any);
+        }
+
+        if (requestParameters['heartbeat_id'] != null) {
+            formParams.append('heartbeat_id', requestParameters['heartbeat_id'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/strategy/heartbeat/ping`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Keep a strategy heartbeat session alive
+     * strategy_heartbeat_ping
+     */
+    async strategyHeartbeatPing(requestParameters: StrategyHeartbeatPingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.strategyHeartbeatPingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/index.ts

@@ -23,6 +23,7 @@ export * from './PushnotifApi';
 export * from './ReferralApi';
 export * from './RootApi';
 export * from './StockfinancialsApi';
+export * from './StrategyApi';
 export * from './TokenlistApi';
 export * from './TransactionApi';
 export * from './TvApi';

package/models/NotificationPreferences.ts

@@ -61,6 +61,18 @@ export interface NotificationPreferences {
      * @memberof NotificationPreferences
      */
     api_key_change_enabled: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NotificationPreferences
+     */
+    strategy_interrupted_enabled: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NotificationPreferences
+     */
+    strategy_finished_enabled: boolean;
 }
 
 /**
@@ -74,6 +86,8 @@ export function instanceOfNotificationPreferences(value: object): value is Notif
     if (!('order_filled_enabled' in value) || value['order_filled_enabled'] === undefined) return false;
     if (!('cashflow_enabled' in value) || value['cashflow_enabled'] === undefined) return false;
     if (!('api_key_change_enabled' in value) || value['api_key_change_enabled'] === undefined) return false;
+    if (!('strategy_interrupted_enabled' in value) || value['strategy_interrupted_enabled'] === undefined) return false;
+    if (!('strategy_finished_enabled' in value) || value['strategy_finished_enabled'] === undefined) return false;
     return true;
 }
 
@@ -94,6 +108,8 @@ export function NotificationPreferencesFromJSONTyped(json: any, ignoreDiscrimina
         'order_filled_enabled': json['order_filled_enabled'],
         'cashflow_enabled': json['cashflow_enabled'],
         'api_key_change_enabled': json['api_key_change_enabled'],
+        'strategy_interrupted_enabled': json['strategy_interrupted_enabled'],
+        'strategy_finished_enabled': json['strategy_finished_enabled'],
     };
 }
 
@@ -110,6 +126,8 @@ export function NotificationPreferencesToJSON(value?: NotificationPreferences |
         'order_filled_enabled': value['order_filled_enabled'],
         'cashflow_enabled': value['cashflow_enabled'],
         'api_key_change_enabled': value['api_key_change_enabled'],
+        'strategy_interrupted_enabled': value['strategy_interrupted_enabled'],
+        'strategy_finished_enabled': value['strategy_finished_enabled'],
     };
 }
 

package/models/PriceOraclePrice.ts

@@ -43,6 +43,12 @@ export interface PriceOraclePrice {
      * @memberof PriceOraclePrice
      */
     median_sources: Array<string>;
+    /**
+     *  what feeds a proxy source, e.g. "0.60 * pythlazer BRENTZ6 + 0.40 * pythlazer BRENTF7" for rolling
+     * @type {string}
+     * @memberof PriceOraclePrice
+     */
+    underlying: string;
     /**
      * 
      * @type {number}
@@ -65,6 +71,7 @@ export function instanceOfPriceOraclePrice(value: object): value is PriceOracleP
     if (!('using_median' in value) || value['using_median'] === undefined) return false;
     if (!('using_internal_price' in value) || value['using_internal_price'] === undefined) return false;
     if (!('median_sources' in value) || value['median_sources'] === undefined) return false;
+    if (!('underlying' in value) || value['underlying'] === undefined) return false;
     if (!('price_cap_bps' in value) || value['price_cap_bps'] === undefined) return false;
     if (!('price_cap_reference_price' in value) || value['price_cap_reference_price'] === undefined) return false;
     return true;
@@ -84,6 +91,7 @@ export function PriceOraclePriceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'using_median': json['using_median'],
         'using_internal_price': json['using_internal_price'],
         'median_sources': json['median_sources'],
+        'underlying': json['underlying'],
         'price_cap_bps': json['price_cap_bps'],
         'price_cap_reference_price': json['price_cap_reference_price'],
     };
@@ -99,6 +107,7 @@ export function PriceOraclePriceToJSON(value?: PriceOraclePrice | null): any {
         'using_median': value['using_median'],
         'using_internal_price': value['using_internal_price'],
         'median_sources': value['median_sources'],
+        'underlying': value['underlying'],
         'price_cap_bps': value['price_cap_bps'],
         'price_cap_reference_price': value['price_cap_reference_price'],
     };

package/models/RespCreateStrategyHeartbeat.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface RespCreateStrategyHeartbeat
+ */
+export interface RespCreateStrategyHeartbeat {
+    /**
+     * 
+     * @type {number}
+     * @memberof RespCreateStrategyHeartbeat
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespCreateStrategyHeartbeat
+     */
+    message?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespCreateStrategyHeartbeat
+     */
+    heartbeat_id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RespCreateStrategyHeartbeat
+     */
+    ping_interval_sec: number;
+}
+
+/**
+ * Check if a given object implements the RespCreateStrategyHeartbeat interface.
+ */
+export function instanceOfRespCreateStrategyHeartbeat(value: object): value is RespCreateStrategyHeartbeat {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('heartbeat_id' in value) || value['heartbeat_id'] === undefined) return false;
+    if (!('ping_interval_sec' in value) || value['ping_interval_sec'] === undefined) return false;
+    return true;
+}
+
+export function RespCreateStrategyHeartbeatFromJSON(json: any): RespCreateStrategyHeartbeat {
+    return RespCreateStrategyHeartbeatFromJSONTyped(json, false);
+}
+
+export function RespCreateStrategyHeartbeatFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespCreateStrategyHeartbeat {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'heartbeat_id': json['heartbeat_id'],
+        'ping_interval_sec': json['ping_interval_sec'],
+    };
+}
+
+export function RespCreateStrategyHeartbeatToJSON(value?: RespCreateStrategyHeartbeat | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'heartbeat_id': value['heartbeat_id'],
+        'ping_interval_sec': value['ping_interval_sec'],
+    };
+}
+

package/models/index.ts

@@ -224,6 +224,7 @@ export * from './RespAtomicOrderList';
 export * from './RespChangeAccountTier';
 export * from './RespCreateEvent';
 export * from './RespCreateRFQ';
+export * from './RespCreateStrategyHeartbeat';
 export * from './RespGaslessDeposit';
 export * from './RespGetApiTokens';
 export * from './RespGetBoPnL';

package/openapi.json

@@ -6142,6 +6142,117 @@
         "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, next_dividend; omit it to get the full record, which requires market_id."
       }
     },
+    "/api/v1/strategy/heartbeat": {
+      "post": {
+        "summary": "strategy_heartbeat",
+        "operationId": "strategy_heartbeat",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespCreateStrategyHeartbeat"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqCreateStrategyHeartbeat"
+            }
+          }
+        ],
+        "tags": [
+          "strategy"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Start a strategy heartbeat session"
+      }
+    },
+    "/api/v1/strategy/heartbeat/finish": {
+      "post": {
+        "summary": "strategy_heartbeat_finish",
+        "operationId": "strategy_heartbeat_finish",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqFinishStrategyHeartbeat"
+            }
+          }
+        ],
+        "tags": [
+          "strategy"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Finish a strategy heartbeat session"
+      }
+    },
+    "/api/v1/strategy/heartbeat/ping": {
+      "post": {
+        "summary": "strategy_heartbeat_ping",
+        "operationId": "strategy_heartbeat_ping",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqPingStrategyHeartbeat"
+            }
+          }
+        ],
+        "tags": [
+          "strategy"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Keep a strategy heartbeat session alive"
+      }
+    },
     "/api/v1/syntheticSpotInfo": {
       "get": {
         "summary": "syntheticSpotInfo",
@@ -11784,6 +11895,14 @@
         "api_key_change_enabled": {
           "type": "boolean",
           "format": "boolean"
+        },
+        "strategy_interrupted_enabled": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "strategy_finished_enabled": {
+          "type": "boolean",
+          "format": "boolean"
         }
       },
       "title": "NotificationPreferences",
@@ -11794,7 +11913,9 @@
         "price_alerts_enabled",
         "order_filled_enabled",
         "cashflow_enabled",
-        "api_key_change_enabled"
+        "api_key_change_enabled",
+        "strategy_interrupted_enabled",
+        "strategy_finished_enabled"
       ]
     },
     "Order": {
@@ -13649,6 +13770,10 @@
             "type": "string"
           }
         },
+        "underlying": {
+          "type": "string",
+          "description": " what feeds a proxy source, e.g. \"0.60 * pythlazer BRENTZ6 + 0.40 * pythlazer BRENTF7\" for rolling"
+        },
         "price_cap_bps": {
           "type": "number",
           "format": "double"
@@ -13665,6 +13790,7 @@
         "using_median",
         "using_internal_price",
         "median_sources",
+        "underlying",
         "price_cap_bps",
         "price_cap_reference_price"
       ]
@@ -14620,6 +14746,26 @@
         "account_index"
       ]
     },
+    "ReqCreateStrategyHeartbeat": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "strategy_type": {
+          "type": "string"
+        }
+      },
+      "title": "ReqCreateStrategyHeartbeat",
+      "required": [
+        "account_index"
+      ]
+    },
     "ReqDeleteAtomicOrder": {
       "type": "object",
       "properties": {
@@ -14772,6 +14918,27 @@
         "to_address"
       ]
     },
+    "ReqFinishStrategyHeartbeat": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "heartbeat_id": {
+          "type": "string"
+        }
+      },
+      "title": "ReqFinishStrategyHeartbeat",
+      "required": [
+        "account_index",
+        "heartbeat_id"
+      ]
+    },
     "ReqGaslessDeposit": {
       "type": "object",
       "properties": {
@@ -16881,6 +17048,27 @@
       },
       "title": "ReqListRFQs"
     },
+    "ReqPingStrategyHeartbeat": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "heartbeat_id": {
+          "type": "string"
+        }
+      },
+      "title": "ReqPingStrategyHeartbeat",
+      "required": [
+        "account_index",
+        "heartbeat_id"
+      ]
+    },
     "ReqPostApiToken": {
       "type": "object",
       "properties": {
@@ -17664,6 +17852,32 @@
         "updated_at"
       ]
     },
+    "RespCreateStrategyHeartbeat": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "heartbeat_id": {
+          "type": "string"
+        },
+        "ping_interval_sec": {
+          "type": "integer",
+          "format": "int64"
+        }
+      },
+      "title": "RespCreateStrategyHeartbeat",
+      "required": [
+        "code",
+        "heartbeat_id",
+        "ping_interval_sec"
+      ]
+    },
     "RespGaslessDeposit": {
       "type": "object",
       "properties": {

package/package.json

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