zklighter-perps 1.0.276 → 1.0.277

package/.openapi-generator/FILES

@@ -9,6 +9,7 @@ apis/FundingApi.ts
 apis/GeckoApi.ts
 apis/GeoApi.ts
 apis/InfoApi.ts
+apis/MarketnewsApi.ts
 apis/NotificationApi.ts
 apis/OrderApi.ts
 apis/PushnotifApi.ts
@@ -94,6 +95,7 @@ models/MarkPriceCandle.ts
 models/MarkPriceCandles.ts
 models/MarketConfig.ts
 models/MarketMetricData.ts
+models/MarketNews.ts
 models/MarketPriceChart.ts
 models/MarketPriceCharts.ts
 models/NextNonce.ts
@@ -195,6 +197,7 @@ models/ReqGetUserReferrals.ts
 models/ReqGetWithdrawHistory.ts
 models/ReqIsWhitelisted.ts
 models/ReqListAtomicOrders.ts
+models/ReqListMarketNews.ts
 models/ReqListRFQs.ts
 models/RespAtomicOrder.ts
 models/RespAtomicOrderList.ts
@@ -213,6 +216,7 @@ models/RespGetMakerOnlyApiKeys.ts
 models/RespGetMarketMetrics.ts
 models/RespGetPushNotifSettings.ts
 models/RespGetRFQ.ts
+models/RespListMarketNews.ts
 models/RespListRFQs.ts
 models/RespPostApiToken.ts
 models/RespPublicPoolsMetadata.ts

package/apis/MarketnewsApi.ts

@@ -0,0 +1,79 @@
+/* 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 {
+  RespListMarketNews,
+  ResultCode,
+} from '../models/index';
+import {
+    RespListMarketNewsFromJSON,
+    RespListMarketNewsToJSON,
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+} from '../models/index';
+
+export interface MarketNewsRequest {
+    authorization?: string;
+    auth?: string;
+    categories?: Array<string>;
+}
+
+/**
+ * 
+ */
+export class MarketnewsApi extends runtime.BaseAPI {
+
+    /**
+     * Get the market news list
+     * market-news
+     */
+    async marketNewsRaw(requestParameters: MarketNewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespListMarketNews>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['authorization'] != null) {
+            queryParameters['authorization'] = requestParameters['authorization'];
+        }
+
+        if (requestParameters['auth'] != null) {
+            queryParameters['auth'] = requestParameters['auth'];
+        }
+
+        if (requestParameters['categories'] != null) {
+            queryParameters['categories'] = requestParameters['categories']!.join(runtime.COLLECTION_FORMATS["csv"]);
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/market-news`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespListMarketNewsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the market news list
+     * market-news
+     */
+    async marketNews(requestParameters: MarketNewsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespListMarketNews> {
+        const response = await this.marketNewsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/index.ts

@@ -11,6 +11,7 @@ export * from './FundingApi';
 export * from './GeckoApi';
 export * from './GeoApi';
 export * from './InfoApi';
+export * from './MarketnewsApi';
 export * from './NotificationApi';
 export * from './OrderApi';
 export * from './PushnotifApi';

package/models/MarketNews.ts

@@ -0,0 +1,106 @@
+/* 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 MarketNews
+ */
+export interface MarketNews {
+    /**
+     * 
+     * @type {string}
+     * @memberof MarketNews
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MarketNews
+     */
+    title: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MarketNews
+     */
+    source: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MarketNews
+     */
+    url: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof MarketNews
+     */
+    sentiment: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof MarketNews
+     */
+    category: string;
+}
+
+/**
+ * Check if a given object implements the MarketNews interface.
+ */
+export function instanceOfMarketNews(value: object): value is MarketNews {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('source' in value) || value['source'] === undefined) return false;
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('sentiment' in value) || value['sentiment'] === undefined) return false;
+    if (!('category' in value) || value['category'] === undefined) return false;
+    return true;
+}
+
+export function MarketNewsFromJSON(json: any): MarketNews {
+    return MarketNewsFromJSONTyped(json, false);
+}
+
+export function MarketNewsFromJSONTyped(json: any, ignoreDiscriminator: boolean): MarketNews {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'title': json['title'],
+        'source': json['source'],
+        'url': json['url'],
+        'sentiment': json['sentiment'],
+        'category': json['category'],
+    };
+}
+
+export function MarketNewsToJSON(value?: MarketNews | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'id': value['id'],
+        'title': value['title'],
+        'source': value['source'],
+        'url': value['url'],
+        'sentiment': value['sentiment'],
+        'category': value['category'],
+    };
+}
+

package/models/ReferralCode.ts

@@ -37,12 +37,6 @@ export interface ReferralCode {
      * @memberof ReferralCode
      */
     referral_code: string;
-    /**
-     * 
-     * @type {number}
-     * @memberof ReferralCode
-     */
-    remaining_usage: number;
 }
 
 /**
@@ -51,7 +45,6 @@ export interface ReferralCode {
 export function instanceOfReferralCode(value: object): value is ReferralCode {
     if (!('code' in value) || value['code'] === undefined) return false;
     if (!('referral_code' in value) || value['referral_code'] === undefined) return false;
-    if (!('remaining_usage' in value) || value['remaining_usage'] === undefined) return false;
     return true;
 }
 
@@ -68,7 +61,6 @@ export function ReferralCodeFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'code': json['code'],
         'message': json['message'] == null ? undefined : json['message'],
         'referral_code': json['referral_code'],
-        'remaining_usage': json['remaining_usage'],
     };
 }
 
@@ -81,7 +73,6 @@ export function ReferralCodeToJSON(value?: ReferralCode | null): any {
         'code': value['code'],
         'message': value['message'],
         'referral_code': value['referral_code'],
-        'remaining_usage': value['remaining_usage'],
     };
 }
 

package/models/ReqListMarketNews.ts

@@ -0,0 +1,68 @@
+/* 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 ReqListMarketNews
+ */
+export interface ReqListMarketNews {
+    /**
+     *  made optional to support header auth clients
+     * @type {string}
+     * @memberof ReqListMarketNews
+     */
+    auth?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ReqListMarketNews
+     */
+    categories?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the ReqListMarketNews interface.
+ */
+export function instanceOfReqListMarketNews(value: object): value is ReqListMarketNews {
+    return true;
+}
+
+export function ReqListMarketNewsFromJSON(json: any): ReqListMarketNews {
+    return ReqListMarketNewsFromJSONTyped(json, false);
+}
+
+export function ReqListMarketNewsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqListMarketNews {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'auth': json['auth'] == null ? undefined : json['auth'],
+        'categories': json['categories'] == null ? undefined : json['categories'],
+    };
+}
+
+export function ReqListMarketNewsToJSON(value?: ReqListMarketNews | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'auth': value['auth'],
+        'categories': value['categories'],
+    };
+}
+

package/models/RespListMarketNews.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 { MarketNews } from './MarketNews';
+import {
+    MarketNewsFromJSON,
+    MarketNewsFromJSONTyped,
+    MarketNewsToJSON,
+} from './MarketNews';
+
+/**
+ * 
+ * @export
+ * @interface RespListMarketNews
+ */
+export interface RespListMarketNews {
+    /**
+     * 
+     * @type {number}
+     * @memberof RespListMarketNews
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespListMarketNews
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Array<MarketNews>}
+     * @memberof RespListMarketNews
+     */
+    market_news_list: Array<MarketNews>;
+}
+
+/**
+ * Check if a given object implements the RespListMarketNews interface.
+ */
+export function instanceOfRespListMarketNews(value: object): value is RespListMarketNews {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('market_news_list' in value) || value['market_news_list'] === undefined) return false;
+    return true;
+}
+
+export function RespListMarketNewsFromJSON(json: any): RespListMarketNews {
+    return RespListMarketNewsFromJSONTyped(json, false);
+}
+
+export function RespListMarketNewsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespListMarketNews {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'market_news_list': ((json['market_news_list'] as Array<any>).map(MarketNewsFromJSON)),
+    };
+}
+
+export function RespListMarketNewsToJSON(value?: RespListMarketNews | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'market_news_list': ((value['market_news_list'] as Array<any>).map(MarketNewsToJSON)),
+    };
+}
+

package/models/index.ts

@@ -75,6 +75,7 @@ export * from './MarkPriceCandle';
 export * from './MarkPriceCandles';
 export * from './MarketConfig';
 export * from './MarketMetricData';
+export * from './MarketNews';
 export * from './MarketPriceChart';
 export * from './MarketPriceCharts';
 export * from './NextNonce';
@@ -176,6 +177,7 @@ export * from './ReqGetUserReferrals';
 export * from './ReqGetWithdrawHistory';
 export * from './ReqIsWhitelisted';
 export * from './ReqListAtomicOrders';
+export * from './ReqListMarketNews';
 export * from './ReqListRFQs';
 export * from './RespAtomicOrder';
 export * from './RespAtomicOrderList';
@@ -194,6 +196,7 @@ export * from './RespGetMakerOnlyApiKeys';
 export * from './RespGetMarketMetrics';
 export * from './RespGetPushNotifSettings';
 export * from './RespGetRFQ';
+export * from './RespListMarketNews';
 export * from './RespListRFQs';
 export * from './RespPostApiToken';
 export * from './RespPublicPoolsMetadata';

package/openapi.json

@@ -2773,6 +2773,58 @@
         "description": "Get mark price candles"
       }
     },
+    "/api/v1/market-news": {
+      "get": {
+        "summary": "market-news",
+        "operationId": "market-news",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespListMarketNews"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "auth",
+            "description": " made optional to support header auth clients",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "categories",
+            "in": "query",
+            "required": false,
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        ],
+        "tags": [
+          "marketnews"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get the market news list"
+      }
+    },
     "/api/v1/marketMetrics": {
       "get": {
         "summary": "marketMetrics",
@@ -8547,6 +8599,39 @@
         "data"
       ]
     },
+    "MarketNews": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        },
+        "source": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        },
+        "sentiment": {
+          "type": "number",
+          "format": "double"
+        },
+        "category": {
+          "type": "string"
+        }
+      },
+      "title": "MarketNews",
+      "required": [
+        "id",
+        "title",
+        "source",
+        "url",
+        "sentiment",
+        "category"
+      ]
+    },
     "MarketPriceChart": {
       "type": "object",
       "properties": {
@@ -10457,18 +10542,12 @@
         "referral_code": {
           "type": "string",
           "example": "5V24K3MJ"
-        },
-        "remaining_usage": {
-          "type": "integer",
-          "format": "int32",
-          "example": "3"
         }
       },
       "title": "ReferralCode",
       "required": [
         "code",
-        "referral_code",
-        "remaining_usage"
+        "referral_code"
       ]
     },
     "ReferralPointEntry": {
@@ -12497,6 +12576,22 @@
       },
       "title": "ReqListAtomicOrders"
     },
+    "ReqListMarketNews": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
+        "categories": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "title": "ReqListMarketNews"
+    },
     "ReqListRFQs": {
       "type": "object",
       "properties": {
@@ -13422,6 +13517,30 @@
         "updated_at"
       ]
     },
+    "RespListMarketNews": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "market_news_list": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/MarketNews"
+          }
+        }
+      },
+      "title": "RespListMarketNews",
+      "required": [
+        "code",
+        "market_news_list"
+      ]
+    },
     "RespListRFQs": {
       "type": "object",
       "properties": {

package/package.json

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