zklighter-perps 1.0.274 → 1.0.275

package/.openapi-generator/FILES

@@ -129,6 +129,8 @@ models/ReferralCode.ts
 models/ReferralPointEntry.ts
 models/ReferralPoints.ts
 models/ReferralTotals.ts
+models/ReferralWeeklyStat.ts
+models/ReferralWeeklyStats.ts
 models/ReqDoFaucet.ts
 models/ReqExportData.ts
 models/ReqGetAccount.ts
@@ -181,6 +183,7 @@ models/ReqGetRangeWithIndexSortable.ts
 models/ReqGetRecentTrades.ts
 models/ReqGetReferralCode.ts
 models/ReqGetReferralPoints.ts
+models/ReqGetReferralWeeklyStats.ts
 models/ReqGetRollingInfo.ts
 models/ReqGetStockFinancials.ts
 models/ReqGetSyntheticSpotInfo.ts

package/apis/ReferralApi.ts

@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   ReferralCode,
   ReferralPoints,
+  ReferralWeeklyStats,
   RespUpdateKickback,
   RespUpdateReferralCode,
   ResultCode,
@@ -27,6 +28,8 @@ import {
     ReferralCodeToJSON,
     ReferralPointsFromJSON,
     ReferralPointsToJSON,
+    ReferralWeeklyStatsFromJSON,
+    ReferralWeeklyStatsToJSON,
     RespUpdateKickbackFromJSON,
     RespUpdateKickbackToJSON,
     RespUpdateReferralCodeFromJSON,
@@ -90,6 +93,12 @@ export interface ReferralUserReferralsRequest {
     stats_end_timestamp?: number;
 }
 
+export interface ReferralWeeklyStatsRequest {
+    l1_address: string;
+    authorization?: string;
+    auth?: string;
+}
+
 /**
  * 
  */
@@ -556,4 +565,51 @@ export class ReferralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get weekly trade stats summed across a referrer\'s referred users
+     * referral_weeklyStats
+     */
+    async referralWeeklyStatsRaw(requestParameters: ReferralWeeklyStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferralWeeklyStats>> {
+        if (requestParameters['l1_address'] == null) {
+            throw new runtime.RequiredError(
+                'l1_address',
+                'Required parameter "l1_address" was null or undefined when calling referralWeeklyStats().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['auth'] != null) {
+            queryParameters['auth'] = requestParameters['auth'];
+        }
+
+        if (requestParameters['l1_address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1_address'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/referral/weeklyStats`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReferralWeeklyStatsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get weekly trade stats summed across a referrer\'s referred users
+     * referral_weeklyStats
+     */
+    async referralWeeklyStats(requestParameters: ReferralWeeklyStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferralWeeklyStats> {
+        const response = await this.referralWeeklyStatsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/apis/TransactionApi.ts

@@ -883,7 +883,8 @@ export const TransferHistoryTypeEnum = {
     L2CreatePublicPool: 'L2CreatePublicPool',
     L2CreateStakingPool: 'L2CreateStakingPool',
     L1BurnShares: 'L1BurnShares',
-    L1UnstakeAssets: 'L1UnstakeAssets'
+    L1UnstakeAssets: 'L1UnstakeAssets',
+    ReferralProgramPayout: 'ReferralProgramPayout'
 } as const;
 export type TransferHistoryTypeEnum = typeof TransferHistoryTypeEnum[keyof typeof TransferHistoryTypeEnum];
 /**

package/models/ReferralTotals.ts

@@ -55,6 +55,18 @@ export interface ReferralTotals {
      * @memberof ReferralTotals
      */
     taker_fees_paid: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReferralTotals
+     */
+    total_referrals: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReferralTotals
+     */
+    total_premium_referrals: number;
 }
 
 /**
@@ -67,6 +79,8 @@ export function instanceOfReferralTotals(value: object): value is ReferralTotals
     if (!('non_free_taker_volume' in value) || value['non_free_taker_volume'] === undefined) return false;
     if (!('maker_fees_paid' in value) || value['maker_fees_paid'] === undefined) return false;
     if (!('taker_fees_paid' in value) || value['taker_fees_paid'] === undefined) return false;
+    if (!('total_referrals' in value) || value['total_referrals'] === undefined) return false;
+    if (!('total_premium_referrals' in value) || value['total_premium_referrals'] === undefined) return false;
     return true;
 }
 
@@ -86,6 +100,8 @@ export function ReferralTotalsFromJSONTyped(json: any, ignoreDiscriminator: bool
         'non_free_taker_volume': json['non_free_taker_volume'],
         'maker_fees_paid': json['maker_fees_paid'],
         'taker_fees_paid': json['taker_fees_paid'],
+        'total_referrals': json['total_referrals'],
+        'total_premium_referrals': json['total_premium_referrals'],
     };
 }
 
@@ -101,6 +117,8 @@ export function ReferralTotalsToJSON(value?: ReferralTotals | null): any {
         'non_free_taker_volume': value['non_free_taker_volume'],
         'maker_fees_paid': value['maker_fees_paid'],
         'taker_fees_paid': value['taker_fees_paid'],
+        'total_referrals': value['total_referrals'],
+        'total_premium_referrals': value['total_premium_referrals'],
     };
 }
 

package/models/ReferralWeeklyStat.ts

@@ -0,0 +1,86 @@
+/* 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';
+import type { TradeStats } from './TradeStats';
+import {
+    TradeStatsFromJSON,
+    TradeStatsFromJSONTyped,
+    TradeStatsToJSON,
+} from './TradeStats';
+
+/**
+ * 
+ * @export
+ * @interface ReferralWeeklyStat
+ */
+export interface ReferralWeeklyStat {
+    /**
+     * 
+     * @type {number}
+     * @memberof ReferralWeeklyStat
+     */
+    start_timestamp: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReferralWeeklyStat
+     */
+    end_timestamp: number;
+    /**
+     * 
+     * @type {TradeStats}
+     * @memberof ReferralWeeklyStat
+     */
+    trade_stats: TradeStats;
+}
+
+/**
+ * Check if a given object implements the ReferralWeeklyStat interface.
+ */
+export function instanceOfReferralWeeklyStat(value: object): value is ReferralWeeklyStat {
+    if (!('start_timestamp' in value) || value['start_timestamp'] === undefined) return false;
+    if (!('end_timestamp' in value) || value['end_timestamp'] === undefined) return false;
+    if (!('trade_stats' in value) || value['trade_stats'] === undefined) return false;
+    return true;
+}
+
+export function ReferralWeeklyStatFromJSON(json: any): ReferralWeeklyStat {
+    return ReferralWeeklyStatFromJSONTyped(json, false);
+}
+
+export function ReferralWeeklyStatFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReferralWeeklyStat {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'start_timestamp': json['start_timestamp'],
+        'end_timestamp': json['end_timestamp'],
+        'trade_stats': TradeStatsFromJSON(json['trade_stats']),
+    };
+}
+
+export function ReferralWeeklyStatToJSON(value?: ReferralWeeklyStat | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'start_timestamp': value['start_timestamp'],
+        'end_timestamp': value['end_timestamp'],
+        'trade_stats': TradeStatsToJSON(value['trade_stats']),
+    };
+}
+

package/models/ReferralWeeklyStats.ts

@@ -0,0 +1,85 @@
+/* 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';
+import type { ReferralWeeklyStat } from './ReferralWeeklyStat';
+import {
+    ReferralWeeklyStatFromJSON,
+    ReferralWeeklyStatFromJSONTyped,
+    ReferralWeeklyStatToJSON,
+} from './ReferralWeeklyStat';
+
+/**
+ * 
+ * @export
+ * @interface ReferralWeeklyStats
+ */
+export interface ReferralWeeklyStats {
+    /**
+     * 
+     * @type {number}
+     * @memberof ReferralWeeklyStats
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReferralWeeklyStats
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Array<ReferralWeeklyStat>}
+     * @memberof ReferralWeeklyStats
+     */
+    weeks: Array<ReferralWeeklyStat>;
+}
+
+/**
+ * Check if a given object implements the ReferralWeeklyStats interface.
+ */
+export function instanceOfReferralWeeklyStats(value: object): value is ReferralWeeklyStats {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('weeks' in value) || value['weeks'] === undefined) return false;
+    return true;
+}
+
+export function ReferralWeeklyStatsFromJSON(json: any): ReferralWeeklyStats {
+    return ReferralWeeklyStatsFromJSONTyped(json, false);
+}
+
+export function ReferralWeeklyStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReferralWeeklyStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'weeks': ((json['weeks'] as Array<any>).map(ReferralWeeklyStatFromJSON)),
+    };
+}
+
+export function ReferralWeeklyStatsToJSON(value?: ReferralWeeklyStats | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'weeks': ((value['weeks'] as Array<any>).map(ReferralWeeklyStatToJSON)),
+    };
+}
+

package/models/ReqGetReferralWeeklyStats.ts

@@ -0,0 +1,69 @@
+/* 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 ReqGetReferralWeeklyStats
+ */
+export interface ReqGetReferralWeeklyStats {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetReferralWeeklyStats
+     */
+    auth?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetReferralWeeklyStats
+     */
+    l1_address: string;
+}
+
+/**
+ * Check if a given object implements the ReqGetReferralWeeklyStats interface.
+ */
+export function instanceOfReqGetReferralWeeklyStats(value: object): value is ReqGetReferralWeeklyStats {
+    if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetReferralWeeklyStatsFromJSON(json: any): ReqGetReferralWeeklyStats {
+    return ReqGetReferralWeeklyStatsFromJSONTyped(json, false);
+}
+
+export function ReqGetReferralWeeklyStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetReferralWeeklyStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'auth': json['auth'] == null ? undefined : json['auth'],
+        'l1_address': json['l1_address'],
+    };
+}
+
+export function ReqGetReferralWeeklyStatsToJSON(value?: ReqGetReferralWeeklyStats | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'auth': value['auth'],
+        'l1_address': value['l1_address'],
+    };
+}
+

package/models/ReqGetTransferHistory.ts

@@ -59,7 +59,8 @@ export const ReqGetTransferHistoryTypeEnum = {
     L2CreatePublicPool: 'L2CreatePublicPool',
     L2CreateStakingPool: 'L2CreateStakingPool',
     L1BurnShares: 'L1BurnShares',
-    L1UnstakeAssets: 'L1UnstakeAssets'
+    L1UnstakeAssets: 'L1UnstakeAssets',
+    ReferralProgramPayout: 'ReferralProgramPayout'
 } as const;
 export type ReqGetTransferHistoryTypeEnum = typeof ReqGetTransferHistoryTypeEnum[keyof typeof ReqGetTransferHistoryTypeEnum];
 

package/models/index.ts

@@ -110,6 +110,8 @@ export * from './ReferralCode';
 export * from './ReferralPointEntry';
 export * from './ReferralPoints';
 export * from './ReferralTotals';
+export * from './ReferralWeeklyStat';
+export * from './ReferralWeeklyStats';
 export * from './ReqDoFaucet';
 export * from './ReqExportData';
 export * from './ReqGetAccount';
@@ -162,6 +164,7 @@ export * from './ReqGetRangeWithIndexSortable';
 export * from './ReqGetRecentTrades';
 export * from './ReqGetReferralCode';
 export * from './ReqGetReferralPoints';
+export * from './ReqGetReferralWeeklyStats';
 export * from './ReqGetRollingInfo';
 export * from './ReqGetStockFinancials';
 export * from './ReqGetSyntheticSpotInfo';

package/openapi.json

@@ -3993,6 +3993,53 @@
         "description": "Get user referrals"
       }
     },
+    "/api/v1/referral/weeklyStats": {
+      "get": {
+        "summary": "referral_weeklyStats",
+        "operationId": "referral_weeklyStats",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ReferralWeeklyStats"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "auth",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "l1_address",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "referral"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get weekly trade stats summed across a referrer's referred users"
+      }
+    },
     "/api/v1/rfq/create": {
       "post": {
         "summary": "rfq_create",
@@ -4927,7 +4974,8 @@
                 "L2CreatePublicPool",
                 "L2CreateStakingPool",
                 "L1BurnShares",
-                "L1UnstakeAssets"
+                "L1UnstakeAssets",
+                "ReferralProgramPayout"
               ]
             }
           }
@@ -10528,6 +10576,14 @@
         },
         "taker_fees_paid": {
           "type": "string"
+        },
+        "total_referrals": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "total_premium_referrals": {
+          "type": "integer",
+          "format": "int64"
         }
       },
       "title": "ReferralTotals",
@@ -10537,7 +10593,55 @@
         "non_free_maker_volume",
         "non_free_taker_volume",
         "maker_fees_paid",
-        "taker_fees_paid"
+        "taker_fees_paid",
+        "total_referrals",
+        "total_premium_referrals"
+      ]
+    },
+    "ReferralWeeklyStat": {
+      "type": "object",
+      "properties": {
+        "start_timestamp": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "end_timestamp": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "trade_stats": {
+          "$ref": "#/definitions/TradeStats"
+        }
+      },
+      "title": "ReferralWeeklyStat",
+      "required": [
+        "start_timestamp",
+        "end_timestamp",
+        "trade_stats"
+      ]
+    },
+    "ReferralWeeklyStats": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "weeks": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ReferralWeeklyStat"
+          }
+        }
+      },
+      "title": "ReferralWeeklyStats",
+      "required": [
+        "code",
+        "weeks"
       ]
     },
     "ReqAckNotif": {
@@ -12055,6 +12159,21 @@
         "account_index"
       ]
     },
+    "ReqGetReferralWeeklyStats": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string"
+        },
+        "l1_address": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetReferralWeeklyStats",
+      "required": [
+        "l1_address"
+      ]
+    },
     "ReqGetRollingInfo": {
       "type": "object",
       "properties": {
@@ -12244,7 +12363,8 @@
               "L2CreatePublicPool",
               "L2CreateStakingPool",
               "L1BurnShares",
-              "L1UnstakeAssets"
+              "L1UnstakeAssets",
+              "ReferralProgramPayout"
             ]
           }
         }

package/package.json

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