zklighter-perps 1.0.173 → 1.0.175

package/.openapi-generator/FILES

@@ -138,6 +138,8 @@ models/RespGetIsNextBridgeFast.ts
 models/RespPublicPoolsMetadata.ts
 models/RespSendTx.ts
 models/RespSendTxBatch.ts
+models/RespUpdateKickback.ts
+models/RespUpdateReferralCode.ts
 models/RespWithdrawalDelay.ts
 models/ResultCode.ts
 models/RiskInfo.ts

package/apis/OrderApi.ts

@@ -623,6 +623,7 @@ export const TradesTypeEnum = {
     All: 'all',
     Trade: 'trade',
     Liquidation: 'liquidation',
-    Deleverage: 'deleverage'
+    Deleverage: 'deleverage',
+    MarketSettlement: 'market-settlement'
 } as const;
 export type TradesTypeEnum = typeof TradesTypeEnum[keyof typeof TradesTypeEnum];

package/apis/ReferralApi.ts

@@ -17,6 +17,8 @@ import * as runtime from '../runtime';
 import type {
   ReferralCode,
   ReferralPoints,
+  RespUpdateKickback,
+  RespUpdateReferralCode,
   ResultCode,
 } from '../models/index';
 import {
@@ -24,6 +26,10 @@ import {
     ReferralCodeToJSON,
     ReferralPointsFromJSON,
     ReferralPointsToJSON,
+    RespUpdateKickbackFromJSON,
+    RespUpdateKickbackToJSON,
+    RespUpdateReferralCodeFromJSON,
+    RespUpdateReferralCodeToJSON,
     ResultCodeFromJSON,
     ResultCodeToJSON,
 } from '../models/index';
@@ -40,12 +46,26 @@ export interface ReferralGetRequest {
     auth?: string;
 }
 
+export interface ReferralKickbackUpdateRequest {
+    account_index: number;
+    kickback_percentage: number;
+    authorization?: string;
+    auth?: string;
+}
+
 export interface ReferralPointsRequest {
     account_index: number;
     authorization?: string;
     auth?: string;
 }
 
+export interface ReferralUpdateRequest {
+    account_index: number;
+    new_referral_code: string;
+    authorization?: string;
+    auth?: string;
+}
+
 export interface ReferralUseRequest {
     l1_address: string;
     referral_code: string;
@@ -169,6 +189,79 @@ export class ReferralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Update kickback percentage for referral rewards
+     * referral_kickback_update
+     */
+    async referralKickbackUpdateRaw(requestParameters: ReferralKickbackUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespUpdateKickback>> {
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling referralKickbackUpdate().'
+            );
+        }
+
+        if (requestParameters['kickback_percentage'] == null) {
+            throw new runtime.RequiredError(
+                'kickback_percentage',
+                'Required parameter "kickback_percentage" was null or undefined when calling referralKickbackUpdate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+        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['kickback_percentage'] != null) {
+            formParams.append('kickback_percentage', requestParameters['kickback_percentage'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/referral/kickback/update`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespUpdateKickbackFromJSON(jsonValue));
+    }
+
+    /**
+     * Update kickback percentage for referral rewards
+     * referral_kickback_update
+     */
+    async referralKickbackUpdate(requestParameters: ReferralKickbackUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespUpdateKickback> {
+        const response = await this.referralKickbackUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get referral points
      * referral_points
@@ -216,6 +309,79 @@ export class ReferralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Update referral code (allowed once per account)
+     * referral_update
+     */
+    async referralUpdateRaw(requestParameters: ReferralUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespUpdateReferralCode>> {
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling referralUpdate().'
+            );
+        }
+
+        if (requestParameters['new_referral_code'] == null) {
+            throw new runtime.RequiredError(
+                'new_referral_code',
+                'Required parameter "new_referral_code" was null or undefined when calling referralUpdate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+        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['new_referral_code'] != null) {
+            formParams.append('new_referral_code', requestParameters['new_referral_code'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/referral/update`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespUpdateReferralCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Update referral code (allowed once per account)
+     * referral_update
+     */
+    async referralUpdate(requestParameters: ReferralUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespUpdateReferralCode> {
+        const response = await this.referralUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Use referral code
      * referral_use

package/models/ReqGetTrades.ts

@@ -129,7 +129,8 @@ export const ReqGetTradesTypeEnum = {
     All: 'all',
     Trade: 'trade',
     Liquidation: 'liquidation',
-    Deleverage: 'deleverage'
+    Deleverage: 'deleverage',
+    MarketSettlement: 'market-settlement'
 } as const;
 export type ReqGetTradesTypeEnum = typeof ReqGetTradesTypeEnum[keyof typeof ReqGetTradesTypeEnum];
 

package/models/RespUpdateKickback.ts

@@ -0,0 +1,78 @@
+/* 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 RespUpdateKickback
+ */
+export interface RespUpdateKickback {
+    /**
+     * 
+     * @type {number}
+     * @memberof RespUpdateKickback
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespUpdateKickback
+     */
+    message?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RespUpdateKickback
+     */
+    success: boolean;
+}
+
+/**
+ * Check if a given object implements the RespUpdateKickback interface.
+ */
+export function instanceOfRespUpdateKickback(value: object): value is RespUpdateKickback {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('success' in value) || value['success'] === undefined) return false;
+    return true;
+}
+
+export function RespUpdateKickbackFromJSON(json: any): RespUpdateKickback {
+    return RespUpdateKickbackFromJSONTyped(json, false);
+}
+
+export function RespUpdateKickbackFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespUpdateKickback {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'success': json['success'],
+    };
+}
+
+export function RespUpdateKickbackToJSON(value?: RespUpdateKickback | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'success': value['success'],
+    };
+}
+

package/models/RespUpdateReferralCode.ts

@@ -0,0 +1,78 @@
+/* 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 RespUpdateReferralCode
+ */
+export interface RespUpdateReferralCode {
+    /**
+     * 
+     * @type {number}
+     * @memberof RespUpdateReferralCode
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespUpdateReferralCode
+     */
+    message?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RespUpdateReferralCode
+     */
+    success: boolean;
+}
+
+/**
+ * Check if a given object implements the RespUpdateReferralCode interface.
+ */
+export function instanceOfRespUpdateReferralCode(value: object): value is RespUpdateReferralCode {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('success' in value) || value['success'] === undefined) return false;
+    return true;
+}
+
+export function RespUpdateReferralCodeFromJSON(json: any): RespUpdateReferralCode {
+    return RespUpdateReferralCodeFromJSONTyped(json, false);
+}
+
+export function RespUpdateReferralCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespUpdateReferralCode {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'success': json['success'],
+    };
+}
+
+export function RespUpdateReferralCodeToJSON(value?: RespUpdateReferralCode | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'success': value['success'],
+    };
+}
+

package/models/Trade.ts

@@ -172,7 +172,8 @@ export interface Trade {
 export const TradeTypeEnum = {
     Trade: 'trade',
     Liquidation: 'liquidation',
-    Deleverage: 'deleverage'
+    Deleverage: 'deleverage',
+    MarketSettlement: 'market-settlement'
 } as const;
 export type TradeTypeEnum = typeof TradeTypeEnum[keyof typeof TradeTypeEnum];
 

package/models/index.ts

@@ -125,6 +125,8 @@ export * from './RespGetIsNextBridgeFast';
 export * from './RespPublicPoolsMetadata';
 export * from './RespSendTx';
 export * from './RespSendTxBatch';
+export * from './RespUpdateKickback';
+export * from './RespUpdateReferralCode';
 export * from './RespWithdrawalDelay';
 export * from './ResultCode';
 export * from './RiskInfo';

package/openapi.json

@@ -2323,6 +2323,50 @@
         "description": "Get referral code"
       }
     },
+    "/api/v1/referral/kickback/update": {
+      "post": {
+        "summary": "referral_kickback_update",
+        "operationId": "referral_kickback_update",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespUpdateKickback"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqUpdateKickback"
+            }
+          }
+        ],
+        "tags": [
+          "referral"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Update kickback percentage for referral rewards"
+      }
+    },
     "/api/v1/referral/points": {
       "get": {
         "summary": "referral_points",
@@ -2373,6 +2417,50 @@
         "description": "Get referral points"
       }
     },
+    "/api/v1/referral/update": {
+      "post": {
+        "summary": "referral_update",
+        "operationId": "referral_update",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespUpdateReferralCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqUpdateReferralCode"
+            }
+          }
+        ],
+        "tags": [
+          "referral"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Update referral code (allowed once per account)"
+      }
+    },
     "/api/v1/referral/use": {
       "post": {
         "summary": "referral_use",
@@ -2646,7 +2734,8 @@
               "all",
               "trade",
               "liquidation",
-              "deleverage"
+              "deleverage",
+              "market-settlement"
             ],
             "default": "all"
           },
@@ -7470,7 +7559,8 @@
             "all",
             "trade",
             "liquidation",
-            "deleverage"
+            "deleverage",
+            "market-settlement"
           ],
           "default": "all"
         },
@@ -7656,6 +7746,50 @@
         "metadata"
       ]
     },
+    "ReqUpdateKickback": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "kickback_percentage": {
+          "type": "number",
+          "format": "double",
+          "maximum": 100
+        }
+      },
+      "title": "ReqUpdateKickback",
+      "required": [
+        "account_index",
+        "kickback_percentage"
+      ]
+    },
+    "ReqUpdateReferralCode": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "new_referral_code": {
+          "type": "string"
+        }
+      },
+      "title": "ReqUpdateReferralCode",
+      "required": [
+        "account_index",
+        "new_referral_code"
+      ]
+    },
     "ReqUseReferralCode": {
       "type": "object",
       "properties": {
@@ -7881,6 +8015,52 @@
         "predicted_execution_time_ms"
       ]
     },
+    "RespUpdateKickback": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "success": {
+          "type": "boolean",
+          "format": "boolean",
+          "example": "true"
+        }
+      },
+      "title": "RespUpdateKickback",
+      "required": [
+        "code",
+        "success"
+      ]
+    },
+    "RespUpdateReferralCode": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "success": {
+          "type": "boolean",
+          "format": "boolean",
+          "example": "true"
+        }
+      },
+      "title": "RespUpdateReferralCode",
+      "required": [
+        "code",
+        "success"
+      ]
+    },
     "RespWithdrawalDelay": {
       "type": "object",
       "properties": {
@@ -8125,7 +8305,8 @@
           "enum": [
             "trade",
             "liquidation",
-            "deleverage"
+            "deleverage",
+            "market-settlement"
           ]
         },
         "market_id": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.173",
+  "version": "1.0.175",
   "description": "zkLighter Perps SDK",
   "main": "index.ts",
   "directories": {