update to v7.1.7

Author: gateio

README.md

@@ -1,4 +1,4 @@
-## gate-api@6.104.3
+## gate-api@7.1.7
 
 TypeScript NodeJS client for gate-api.
 
@@ -7,7 +7,7 @@ APIv4 provides operations related to spot, margin, and contract trading, includi
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v4.104.3
+- API version: v4.105.7
 - Package version: 
 - Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen
 For more information, please visit [https://www.gate.com/page/contacts](https://www.gate.com/page/contacts)
@@ -327,7 +327,7 @@ Class | Method | HTTP request | Description
 *UnifiedApi* | [**getUnifiedMode**](docs/UnifiedApi.md#getUnifiedMode) | **GET** /unified/unified_mode | Query mode of the unified account
 *UnifiedApi* | [**setUnifiedMode**](docs/UnifiedApi.md#setUnifiedMode) | **PUT** /unified/unified_mode | Set unified account mode
 *UnifiedApi* | [**getUnifiedEstimateRate**](docs/UnifiedApi.md#getUnifiedEstimateRate) | **GET** /unified/estimate_rate | Query unified account estimated interest rate
-*UnifiedApi* | [**listCurrencyDiscountTiers**](docs/UnifiedApi.md#listCurrencyDiscountTiers) | **GET** /unified/currency_discount_tiers | Query unified account tiered discount
+*UnifiedApi* | [**listCurrencyDiscountTiers**](docs/UnifiedApi.md#listCurrencyDiscountTiers) | **GET** /unified/currency_discount_tiers | Query unified account tiered
 *UnifiedApi* | [**listLoanMarginTiers**](docs/UnifiedApi.md#listLoanMarginTiers) | **GET** /unified/loan_margin_tiers | Query unified account tiered loan margin
 *UnifiedApi* | [**calculatePortfolioMargin**](docs/UnifiedApi.md#calculatePortfolioMargin) | **POST** /unified/portfolio_calculator | Portfolio margin calculator
 *UnifiedApi* | [**getUserLeverageCurrencyConfig**](docs/UnifiedApi.md#getUserLeverageCurrencyConfig) | **GET** /unified/leverage/user_currency_config | Maximum and minimum currency leverage that can be set

api/deliveryApi.ts

@@ -200,7 +200,7 @@ export class DeliveryApi {
      * @param contract Futures contract
      * @param opts Optional parameters
      * @param opts.limit Maximum number of records returned in a single list
-     * @param opts.lastId 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围
+     * @param opts.lastId Use the ID of the last record in the previous list as the starting point for the next list.This field is no longer supported. For new requests, please use the fromand tofields to specify the time rang
      * @param opts.from Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned.
      * @param opts.to Specify end time in Unix seconds, default to current time.
      */
@@ -271,7 +271,7 @@ export class DeliveryApi {
      * @param opts.from Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
      * @param opts.to Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
      * @param opts.limit Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
-     * @param opts.interval Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeTime interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time
+     * @param opts.interval Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial time
      */
     public async listDeliveryCandlesticks(
         settle: 'usdt',
@@ -490,7 +490,7 @@ export class DeliveryApi {
      * @param opts.limit Maximum number of records returned in a single list
      * @param opts.from Start timestamp  Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
      * @param opts.to Termination Timestamp  Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
-     * @param opts.type Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate
+     * @param opts.type Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates
      */
     public async listDeliveryAccountBook(
         settle: 'usdt',
@@ -823,7 +823,7 @@ export class DeliveryApi {
      * @param opts.contract Futures contract
      * @param opts.limit Maximum number of records returned in a single list
      * @param opts.offset List offset, starting from 0
-     * @param opts.lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time
+     * @param opts.lastId Use the ID of the last record in the previous list as the starting point for the next list  Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
      * @param opts.countTotal Whether to return total number matched, defaults to 0 (no return)
      */
     public async listDeliveryOrders(
@@ -1088,7 +1088,7 @@ export class DeliveryApi {
      * @param opts.order Futures order ID, return related data only if specified
      * @param opts.limit Maximum number of records returned in a single list
      * @param opts.offset List offset, starting from 0
-     * @param opts.lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time
+     * @param opts.lastId Use the ID of the last record in the previous list as the starting point for the next list  Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
      * @param opts.countTotal Whether to return total number matched, defaults to 0 (no return)
      */
     public async getMyDeliveryTrades(
@@ -1317,7 +1317,7 @@ export class DeliveryApi {
     }
 
     /**
-     * When the \'contract\' parameter is not passed, the default is to query the risk limits for the top 100 markets.\'Limit\' and \'offset\' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty.
+     * When the \'contract\' parameter is not passed, the default is to query the risk limits for the top 100 markets. \'Limit\' and \'offset\' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty.
      * @summary Query risk limit tiers
      * @param settle Settle currency
      * @param opts Optional parameters

api/earnApi.ts

@@ -362,7 +362,7 @@ export class EarnApi {
      * @summary Staking coins
      * @param findCoin
      */
-    public async findCoin(findCoin: FindCoin): Promise<{ response: AxiosResponse; body: Array<string> }> {
+    public async findCoin(findCoin: FindCoin): Promise<{ response: AxiosResponse; body: object }> {
         const localVarPath = this.client.basePath + '/earn/staking/coins';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this.client.defaultHeaders);
@@ -388,7 +388,7 @@ export class EarnApi {
         };
 
         const authSettings = ['apiv4'];
-        return this.client.request<Array<string>>(config, 'Array<string>', authSettings);
+        return this.client.request<object>(config, 'object', authSettings);
     }
 
     /**

api/futuresApi.ts

@@ -306,6 +306,7 @@ export class FuturesApi {
      * @param opts.to Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
      * @param opts.limit Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
      * @param opts.interval Interval time between data points. Note that `1w` means natural week(Mon-Sun), while `7d` means every 7d since unix 0. 30d represents a natural month, not 30 days
+     * @param opts.timezone Time zone: all/utc0/utc8, default utc0
      */
     public async listFuturesCandlesticks(
         settle: 'btc' | 'usdt',
@@ -315,6 +316,7 @@ export class FuturesApi {
             to?: number;
             limit?: number;
             interval?: '10s' | '1m' | '5m' | '15m' | '30m' | '1h' | '4h' | '8h' | '1d' | '7d';
+            timezone?: string;
         },
     ): Promise<{ response: AxiosResponse; body: Array<FuturesCandlestick> }> {
         const localVarPath =
@@ -362,6 +364,10 @@ export class FuturesApi {
             );
         }
 
+        if (opts.timezone !== undefined) {
+            localVarQueryParameters['timezone'] = ObjectSerializer.serialize(opts.timezone, 'string');
+        }
+
         const config: AxiosRequestConfig = {
             method: 'GET',
             params: localVarQueryParameters,
@@ -719,7 +725,7 @@ export class FuturesApi {
     }
 
     /**
-     * The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for detailsThe time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details
+     * The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for details
      * @summary Query liquidation order history
      * @param settle Settle currency
      * @param opts Optional parameters
@@ -779,7 +785,7 @@ export class FuturesApi {
     }
 
     /**
-     * When the \'contract\' parameter is not passed, the default is to query the risk limits for the top 100 markets.\'Limit\' and \'offset\' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty.
+     * When the \'contract\' parameter is not passed, the default is to query the risk limits for the top 100 markets. \'Limit\' and \'offset\' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty.
      * @summary Query risk limit tiers
      * @param settle Settle currency
      * @param opts Optional parameters
@@ -880,7 +886,7 @@ export class FuturesApi {
      * @param opts.offset List offset, starting from 0
      * @param opts.from Start timestamp  Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
      * @param opts.to Termination Timestamp  Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
-     * @param opts.type Changing Type：  - dnw: Deposit &amp; Withdraw - pnl: Profit &amp; Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction
+     * @param opts.type Change types:  - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates - bonus_offset: Trial fund deduction
      */
     public async listFuturesAccountBook(
         settle: 'btc' | 'usdt',
@@ -1104,12 +1110,13 @@ export class FuturesApi {
      * @param leverage New position leverage
      * @param opts Optional parameters
      * @param opts.crossLeverageLimit Cross margin leverage (valid only when &#x60;leverage&#x60; is 0)
+     * @param opts.pid Product ID
      */
     public async updatePositionLeverage(
         settle: 'btc' | 'usdt',
         contract: string,
         leverage: string,
-        opts: { crossLeverageLimit?: string },
+        opts: { crossLeverageLimit?: string; pid?: number },
     ): Promise<{ response: AxiosResponse; body: Position }> {
         const localVarPath =
             this.client.basePath +
@@ -1151,6 +1158,10 @@ export class FuturesApi {
             );
         }
 
+        if (opts.pid !== undefined) {
+            localVarQueryParameters['pid'] = ObjectSerializer.serialize(opts.pid, 'number');
+        }
+
         const config: AxiosRequestConfig = {
             method: 'POST',
             params: localVarQueryParameters,
@@ -1622,7 +1633,7 @@ export class FuturesApi {
      * @param opts.contract Futures contract, return related data only if specified
      * @param opts.limit Maximum number of records returned in a single list
      * @param opts.offset List offset, starting from 0
-     * @param opts.lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time
+     * @param opts.lastId Use the ID of the last record in the previous list as the starting point for the next list  Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
      */
     public async listFuturesOrders(
         settle: 'btc' | 'usdt',
@@ -1742,12 +1753,14 @@ export class FuturesApi {
      * @param contract Futures contract
      * @param opts Optional parameters
      * @param opts.xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
-     * @param opts.side Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders
+     * @param opts.side Specify all buy orders or all sell orders, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell orders
+     * @param opts.excludeReduceOnly Whether to exclude reduce-only orders
+     * @param opts.text Remark for order cancellation
      */
     public async cancelFuturesOrders(
         settle: 'btc' | 'usdt',
         contract: string,
-        opts: { xGateExptime?: string; side?: string },
+        opts: { xGateExptime?: string; side?: string; excludeReduceOnly?: boolean; text?: string },
     ): Promise<{ response: AxiosResponse; body: Array<FuturesOrder> }> {
         const localVarPath =
             this.client.basePath +
@@ -1779,6 +1792,17 @@ export class FuturesApi {
             localVarQueryParameters['side'] = ObjectSerializer.serialize(opts.side, 'string');
         }
 
+        if (opts.excludeReduceOnly !== undefined) {
+            localVarQueryParameters['exclude_reduce_only'] = ObjectSerializer.serialize(
+                opts.excludeReduceOnly,
+                'boolean',
+            );
+        }
+
+        if (opts.text !== undefined) {
+            localVarQueryParameters['text'] = ObjectSerializer.serialize(opts.text, 'string');
+        }
+
         if (opts.xGateExptime !== undefined) {
             localVarHeaderParams['x-gate-exptime'] = ObjectSerializer.serialize(opts.xGateExptime, 'string');
         }

api/multiCollateralLoanApi.ts

@@ -50,7 +50,7 @@ export class MultiCollateralLoanApi {
      * @param opts.page Page number
      * @param opts.limit Maximum number of records returned in a single list
      * @param opts.sort Sort type: `time_desc` - Created time descending (default), `ltv_asc` - Collateral ratio ascending, `ltv_desc` - Collateral ratio descending.
-     * @param opts.orderType Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specifiedOrder type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified
+     * @param opts.orderType Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified
      */
     public async listMultiCollateralOrders(opts: {
         page?: number;

api/rebateApi.ts

@@ -113,6 +113,7 @@ export class RebateApi {
      * @summary Broker obtains rebate history of recommended users
      * @param opts Optional parameters
      * @param opts.currency Specify the currency. If not specified, returns all currencies
+     * @param opts.commissionType Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate
      * @param opts.userId User ID. If not specified, all user records will be returned
      * @param opts.from Start time for querying records, defaults to 7 days before current time if not specified
      * @param opts.to End timestamp for the query, defaults to current time if not specified
@@ -121,6 +122,7 @@ export class RebateApi {
      */
     public async agencyCommissionsHistory(opts: {
         currency?: string;
+        commissionType?: number;
         userId?: number;
         from?: number;
         to?: number;
@@ -143,6 +145,10 @@ export class RebateApi {
             localVarQueryParameters['currency'] = ObjectSerializer.serialize(opts.currency, 'string');
         }
 
+        if (opts.commissionType !== undefined) {
+            localVarQueryParameters['commission_type'] = ObjectSerializer.serialize(opts.commissionType, 'number');
+        }
+
         if (opts.userId !== undefined) {
             localVarQueryParameters['user_id'] = ObjectSerializer.serialize(opts.userId, 'number');
         }

api/spotApi.ts

@@ -282,7 +282,7 @@ export class SpotApi {
      * @param currencyPair Currency pair
      * @param opts Optional parameters
      * @param opts.limit Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000
-     * @param opts.lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time
+     * @param opts.lastId Use the ID of the last record in the previous list as the starting point for the next list  Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
      * @param opts.reverse Whether to retrieve data less than `last_id`. Default returns records greater than `last_id`.  Set to `true` to trace back market trade records, `false` to get latest trades.  No effect when `last_id` is not set.
      * @param opts.from Start timestamp for the query
      * @param opts.to End timestamp for the query, defaults to current time if not specified

api/unifiedApi.ts

@@ -573,7 +573,7 @@ export class UnifiedApi {
 
     /**
      *
-     * @summary Query unified account tiered discount
+     * @summary Query unified account tiered
      */
     public async listCurrencyDiscountTiers(): Promise<{ response: AxiosResponse; body: Array<UnifiedDiscount> }> {
         const localVarPath = this.client.basePath + '/unified/currency_discount_tiers';