update SDK release to 1.1.0

Author: revilwang

README.md

@@ -1,7 +1,7 @@
-# gate-client
+# gate-api
 
 Gate API v4
-- API version: 1.0.0
+- API version: 1.1.0
 
 APIv4 futures provides all sorts of futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf.
 
@@ -39,8 +39,8 @@ Add this dependency to your project's POM:
 ```xml
 <dependency>
   <groupId>io.gate</groupId>
-  <artifactId>gate-client</artifactId>
-  <version>1.0.0</version>
+  <artifactId>gate-api</artifactId>
+  <version>1.1.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -50,7 +50,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-compile "io.gate:gate-client:1.0.0"
+compile "io.gate:gate-api:1.1.0"
 ```
 
 ### Others
@@ -63,38 +63,33 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/gate-client-1.0.0.jar`
+* `target/gate-api-1.1.0.jar`
 * `target/lib/*.jar`
 
 ## Getting Started
 
 Please follow the [installation](#installation) instruction and execute the following Java code:
 
 ```java
-import io.gate.gateapi.ApiClient;
+
+import io.gate.gateapi.*;
+import io.gate.gateapi.models.*;
 import io.gate.gateapi.api.FuturesApi;
-import io.gate.gateapi.models.Contract;
-import io.gate.gateapi.models.FuturesOrder;
+
+import java.io.File;
+import java.util.*;
 
 public class FuturesApiExample {
 
     public static void main(String[] args) {
-        ApiClient apiClient = new ApiClient("YOUR_API_KEY", "YOUR_API_SECRET");
-        // uncomment the next line if testing the API with TestNet
-        // apiClient.setBasePath("https://fx-api-testnet.gateio.io/api/v4");
-        FuturesApi futuresApi = new FuturesApi(apiClient);
+        ApiClient client = new ApiClient("YOUR_API_KEY", "YOUR_API_SECRET");
+        // uncomment the next line if testing the API with other host
+        // apiClient.setBasePath("https://some-other-host");
+        FuturesApi apiInstance = new FuturesApi(client);
+        String orderId = "12345"; // String | ID returned on order successfully being created
         try {
-            List<Contract> contracts = futuresApi.listFuturesContracts();
-            for (Contract c: contracts) {
-                System.out.println(c.getName());
-            }
-            String contract = "BTC_USD";
-            FuturesOrder order = new FuturesOrder();
-            order.setContract(contract);
-            order.setSize(100L);
-            order.setPrice("4000");
-            order = futuresApi.createOrder(order);
-            System.out.println(order.getId());
+            FuturesOrder result = apiInstance.cancelOrder(orderId);
+            System.out.println(result);
         } catch (ApiException e) {
             System.err.println(e.getResponseBody());
             e.printStackTrace();
@@ -124,10 +119,11 @@ Class | Method | HTTP request | Description
 *FuturesApi* | [**listFuturesTickers**](docs/FuturesApi.md#listFuturesTickers) | **GET** /futures/tickers | List futures tickers
 *FuturesApi* | [**listFuturesTrades**](docs/FuturesApi.md#listFuturesTrades) | **GET** /futures/trades | Futures trading history
 *FuturesApi* | [**listOrders**](docs/FuturesApi.md#listOrders) | **GET** /futures/orders | List futures orders
-*FuturesApi* | [**listPositions**](docs/FuturesApi.md#listPositions) | **GET** /futures/positions | List all positions
+*FuturesApi* | [**listPositionClose**](docs/FuturesApi.md#listPositionClose) | **GET** /futures/position_close | List position close history
+*FuturesApi* | [**listPositions**](docs/FuturesApi.md#listPositions) | **GET** /futures/positions | List all positions of a user
 *FuturesApi* | [**updatePositionLeverage**](docs/FuturesApi.md#updatePositionLeverage) | **POST** /futures/positions/{contract}/leverage | Update position leverage
 *FuturesApi* | [**updatePositionMargin**](docs/FuturesApi.md#updatePositionMargin) | **POST** /futures/positions/{contract}/margin | Update position margin
-*FuturesApi* | [**updatePositionRiskLimit**](docs/FuturesApi.md#updatePositionRiskLimit) | **POST** /futures/positions/{contract}/risk_limit | Update poisition risk limit
+*FuturesApi* | [**updatePositionRiskLimit**](docs/FuturesApi.md#updatePositionRiskLimit) | **POST** /futures/positions/{contract}/risk_limit | Update position risk limit
 
 
 ## Documentation for Models
@@ -136,7 +132,6 @@ Class | Method | HTTP request | Description
  - [FundingRateRecord](docs/FundingRateRecord.md)
  - [FuturesAccount](docs/FuturesAccount.md)
  - [FuturesCandlestick](docs/FuturesCandlestick.md)
- - [FuturesErrorResponse](docs/FuturesErrorResponse.md)
  - [FuturesOrder](docs/FuturesOrder.md)
  - [FuturesOrderBook](docs/FuturesOrderBook.md)
  - [FuturesOrderBookItem](docs/FuturesOrderBookItem.md)
@@ -145,6 +140,8 @@ Class | Method | HTTP request | Description
  - [InsuranceRecord](docs/InsuranceRecord.md)
  - [MyFuturesTrade](docs/MyFuturesTrade.md)
  - [Position](docs/Position.md)
+ - [PositionClose](docs/PositionClose.md)
+ - [PositionCloseOrder](docs/PositionCloseOrder.md)
 
 
 ## Recommendation

build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'idea'
 apply plugin: 'eclipse'
 
 group = 'io.gate'
-version = '1.0.0'
+version = '1.1.0'
 
 buildscript {
     repositories {
@@ -83,7 +83,7 @@ if(hasProperty('target') && target == 'android') {
 
     install {
         repositories.mavenInstaller {
-            pom.artifactId = 'gate-client'
+            pom.artifactId = 'gate-api'
         }
     }
 

build.sbt

@@ -1,8 +1,8 @@
 lazy val root = (project in file(".")).
   settings(
     organization := "io.gate",
-    name := "gate-client",
-    version := "1.0.0",
+    name := "gate-api",
+    version := "1.1.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/Contract.md

@@ -4,32 +4,40 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Futures name |  [optional]
-**type** | [**TypeEnum**](#TypeEnum) | Futures type |  [optional]
+**name** | **String** | Futures contract name |  [optional]
+**type** | [**TypeEnum**](#TypeEnum) | Futures contract type |  [optional]
 **quantoMultiplier** | **String** | Multiplier used in converting from invoicing to settlement currency in quanto futures |  [optional]
-**leverageMin** | **String** | minimum leverage |  [optional]
-**leverageMax** | **String** | maximum leverage |  [optional]
-**markType** | [**MarkTypeEnum**](#MarkTypeEnum) | mark price type, internal - based on internal trading, index - based on external index price |  [optional]
-**markPrice** | **String** | latest mark price |  [optional]
-**indexPrice** | **String** | latest index price |  [optional]
-**maintenanceRate** | **String** | maintenance rate of margin |  [optional]
-**fundingRate** | **String** | funding rate |  [optional]
-**fundingInterval** | **Integer** | funding application interval, unit in seconds |  [optional]
-**fundingNextApply** | [**BigDecimal**](BigDecimal.md) | next funding time |  [optional]
-**riskLimitBase** | **String** | risk limit base |  [optional]
-**riskLimitStep** | **String** | step of adjusting risk limit |  [optional]
-**riskLimitMax** | **String** | maximum risk limit the contract allowed |  [optional]
-**orderSizeMin** | **Long** | minimum order size the contract allowed |  [optional]
-**orderSizeMax** | **Long** | maximum order size the contract allowed |  [optional]
-**orderPriceDeviate** | **String** | deviation between order price and current index price. If price of an order is denoted as `order_price`, it must meet the following condition:      abs(order_price - mark_price) <= mark_price * order_price_deviate  |  [optional]
+**leverageMin** | **String** | Minimum leverage |  [optional]
+**leverageMax** | **String** | Maximum leverage |  [optional]
+**maintenanceRate** | **String** | Maintenance rate of margin |  [optional]
+**markType** | [**MarkTypeEnum**](#MarkTypeEnum) | Mark price type, internal - based on internal trading, index - based on external index price |  [optional]
+**markPrice** | **String** | Current mark price |  [optional]
+**indexPrice** | **String** | Current index price |  [optional]
+**lastPrice** | **String** | Last trading price |  [optional]
+**makerFeeRate** | **String** | Maker fee rate, where negative means rebate |  [optional]
+**takerFeeRate** | **String** | Taker fee rate |  [optional]
+**orderPriceRound** | **String** | Minimum order price increment |  [optional]
+**markPriceRound** | **String** | Minimum mark price increment |  [optional]
+**fundingRate** | **String** | Current funding rate |  [optional]
+**fundingInterval** | **Integer** | Funding application interval, unit in seconds |  [optional]
+**fundingNextApply** | [**BigDecimal**](BigDecimal.md) | Next funding time |  [optional]
+**riskLimitBase** | **String** | Risk limit base |  [optional]
+**riskLimitStep** | **String** | Step of adjusting risk limit |  [optional]
+**riskLimitMax** | **String** | Maximum risk limit the contract allowed |  [optional]
+**orderSizeMin** | **Long** | Minimum order size the contract allowed |  [optional]
+**orderSizeMax** | **Long** | Maximum order size the contract allowed |  [optional]
+**orderPriceDeviate** | **String** | deviation between order price and current index price. If price of an order is denoted as order_price, it must meet the following condition:      abs(order_price - mark_price) <= mark_price * order_price_deviate |  [optional]
+**orderbookId** | **Long** | Current orderbook ID |  [optional]
+**tradeId** | **Long** | Current trade ID |  [optional]
+**tradeSize** | **Long** | Historical accumulation trade size |  [optional]
+**positionSize** | **Long** | Current total long position size |  [optional]
 
 
 <a name="TypeEnum"></a>
 ## Enum: TypeEnum
 Name | Value
 ---- | -----
 INVERSE | &quot;inverse&quot;
-QUANTO | &quot;quanto&quot;
 DIRECT | &quot;direct&quot;
 
 

docs/FundingRateRecord.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **t** | **Long** | Unix timestamp in seconds |  [optional]
-**r** | **String** | funding rate |  [optional]
+**r** | **String** | Funding rate |  [optional]
 
 
 

docs/FuturesAccount.md

@@ -4,11 +4,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**total** | **String** | total assets, total = position_margin + order_margin + available |  [optional]
-**unrealisedPnl** | **String** | unrealized pnl |  [optional]
-**positionMargin** | **String** | position margin |  [optional]
-**orderMargin** | **String** | order margin of unfinished orders |  [optional]
-**available** | **String** | available balance to transfer out or trade |  [optional]
+**total** | **String** | Total assets, total = position_margin + order_margin + available |  [optional]
+**unrealisedPnl** | **String** | Unrealized PNL |  [optional]
+**positionMargin** | **String** | Position margin |  [optional]
+**orderMargin** | **String** | Order margin of unfinished orders |  [optional]
+**available** | **String** | Available balance to transfer out or trade |  [optional]