add return type hints; format code

Author: revilwang

.gitignore

@@ -45,7 +45,9 @@ coverage.xml
 *,cover
 .hypothesis/
 venv/
+.venv/
 .python-version
+.pytest_cache
 
 # Translations
 *.mo

.gitlab-ci.yml

@@ -0,0 +1,33 @@
+# ref: https://docs.gitlab.com/ee/ci/README.html
+
+stages:
+  - test
+
+.nosetest:
+  stage: test
+  script:
+   - pip install -r requirements.txt
+   - pip install -r test-requirements.txt
+   - pytest --cov=gate_api
+
+nosetest-2.7:
+  extends: .nosetest
+  image: python:2.7-alpine
+nosetest-3.3:
+  extends: .nosetest
+  image: python:3.3-alpine
+nosetest-3.4:
+  extends: .nosetest
+  image: python:3.4-alpine
+nosetest-3.5:
+  extends: .nosetest
+  image: python:3.5-alpine
+nosetest-3.6:
+  extends: .nosetest
+  image: python:3.6-alpine
+nosetest-3.7:
+  extends: .nosetest
+  image: python:3.7-alpine
+nosetest-3.8:
+  extends: .nosetest
+  image: python:3.8-alpine

.openapi-generator-ignore

@@ -6,9 +6,12 @@ python:
   - "3.3"
   - "3.4"
   - "3.5"
-  #- "3.5-dev" # 3.5 development branch
-  #- "nightly" # points to the latest development branch e.g. 3.6-dev
+  - "3.6"
+  - "3.7"
+  - "3.8"
 # command to install dependencies
-install: "pip install -r requirements.txt"
+install:
+  - "pip install -r requirements.txt"
+  - "pip install -r test-requirements.txt"
 # command to run tests
-script: nosetests
+script: pytest --cov=gate_api

.openapi-generator/VERSION

@@ -3,11 +3,35 @@ APIv4 provides spot, margin and futures trading operations. There are public API
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 4.15.1
-- Package version: 4.15.1
+- API version: 4.15.2
+- Package version: 4.15.2
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
 
+## Versioning
+
+Trying our best to follow the [semantic versioning](https://semver.org/), while enjoying recent features
+provided by programming language and libraries, from 4.15.2, one major versioning difference will be
+introduced:
+
+If extra code rewrite is required when you upgrade the SDK, such as:
+
+- some outdated programming language version support is dropped
+- API method signature has breaking changes.
+
+**the MAJOR version will be incremented, but the MINOR and PATCH version are still following REST API's
+instead of resetting to 0**, so that you can recognize it has some breaking changes, but still getting
+the idea of from which REST API version the change is introduced.
+
+For example, the previous REST API and SDK version are both 4.14.0. But if we decide to introduce
+some breaking changes in SDK along with REST API 4.15.2 upgrade, then the version of next SDK release
+will be 5.15.2(the MAJOR version is incremented to denote breaking changes, but the MINOR and PATCH
+version are identical to REST API's instead of resetting them to 0)
+
+If MAJOR version is incremented, make sure you read the release note on
+[Releases](https://github.com/gateio/gateapi-python/releases)
+page
+
 ## Requirements.
 
 Python 2.7 and 3.4+
@@ -156,6 +180,7 @@ Class | Method | HTTP request | Description
 *SpotApi* | [**list_order_book**](docs/SpotApi.md#list_order_book) | **GET** /spot/order_book | Retrieve order book
 *SpotApi* | [**list_trades**](docs/SpotApi.md#list_trades) | **GET** /spot/trades | Retrieve market trades
 *SpotApi* | [**list_candlesticks**](docs/SpotApi.md#list_candlesticks) | **GET** /spot/candlesticks | Market candlesticks
+*SpotApi* | [**get_fee**](docs/SpotApi.md#get_fee) | **GET** /spot/fee | Query user trading fee rates
 *SpotApi* | [**list_spot_accounts**](docs/SpotApi.md#list_spot_accounts) | **GET** /spot/accounts | List spot accounts
 *SpotApi* | [**create_batch_orders**](docs/SpotApi.md#create_batch_orders) | **POST** /spot/batch_orders | Create a batch of orders
 *SpotApi* | [**list_all_open_orders**](docs/SpotApi.md#list_all_open_orders) | **GET** /spot/open_orders | List all open orders
@@ -222,6 +247,7 @@ Class | Method | HTTP request | Description
  - [SubAccountTransfer](docs/SubAccountTransfer.md)
  - [Ticker](docs/Ticker.md)
  - [Trade](docs/Trade.md)
+ - [TradeFee](docs/TradeFee.md)
  - [Transfer](docs/Transfer.md)
  - [TriggerOrderResponse](docs/TriggerOrderResponse.md)
 

.travis.yml

@@ -111,7 +111,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 
 try:
     # Get a single contract
@@ -171,7 +171,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 interval = '0' # str | Order depth. 0 means no aggregation is applied. default to 0 (optional) (default to '0')
 limit = 10 # int | Maximum number of order depth data in asks or bids (optional) (default to 10)
 
@@ -233,7 +233,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 limit = 100 # int | Maximum number of records returned in one list (optional) (default to 100)
 last_id = '12345' # str | Specify list staring point using the id of last record in previous list-query results  This parameter is deprecated. Use `from` and `to` instead to limit time range (optional)
 _from = 1546905600 # float | 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.  (optional)
@@ -301,7 +301,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 _from = 1546905600 # float | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified (optional)
 to = 1546935600 # float | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional)
 limit = 100 # int | Maximum recent data points returned. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
@@ -367,7 +367,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract (optional)
+contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
 
 try:
     # List futures tickers
@@ -695,7 +695,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 
 try:
     # Get single position
@@ -762,7 +762,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 change = '0.01' # str | Margin change. Use positive number to increase margin, negative number otherwise.
 
 try:
@@ -831,7 +831,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 leverage = '10' # str | New position leverage
 
 try:
@@ -900,7 +900,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 risk_limit = '10' # str | New position risk limit
 
 try:
@@ -972,7 +972,7 @@ api_client = gate_api.ApiClient(configuration)
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
 status = 'open' # str | List orders based on status
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract (optional)
+contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
 limit = 100 # int | Maximum number of records returned in one list (optional) (default to 100)
 offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
 last_id = '12345' # str | Specify list staring point using the `id` of last record in previous list-query results (optional)
@@ -1050,7 +1050,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-futures_order = {"id":15675394,"user":100000,"contract":"BTC_USD","create_time":1546569968,"size":6024,"iceberg":0,"left":6024,"price":"3765","fill_price":"0","mkfr":"-0.00025","tkfr":"0.00075","tif":"gtc","refu":0,"is_reduce_only":false,"is_close":false,"is_liq":false,"text":"t-my-custom-id","status":"finished","finish_time":1514764900,"finish_as":"cancelled"} # FuturesOrder | 
+futures_order = gate_api.FuturesOrder() # FuturesOrder | 
 
 try:
     # Create a futures order
@@ -1119,7 +1119,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract
+contract = 'BTC_USDT_20200814' # str | Futures contract
 side = 'ask' # str | All bids or asks. Both included in not specified (optional)
 
 try:
@@ -1324,7 +1324,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract (optional)
+contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
 order = 12345 # int | Futures order ID, return related data only if specified (optional)
 limit = 100 # int | Maximum number of records returned in one list (optional) (default to 100)
 offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
@@ -1401,7 +1401,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract (optional)
+contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
 limit = 100 # int | Maximum number of records returned in one list (optional) (default to 100)
 
 try:
@@ -1470,7 +1470,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract (optional)
+contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
 limit = 100 # int | Maximum number of records returned in one list (optional) (default to 100)
 at = 0 # int | Specify a liquidation timestamp (optional) (default to 0)
 
@@ -1541,7 +1541,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-contract = 'BTC_USDT_WEEKLY_20200703' # str | Futures contract (optional)
+contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
 limit = 100 # int | Maximum number of records returned in one list (optional) (default to 100)
 at = 0 # int | Specify a settlement timestamp (optional) (default to 0)
 
@@ -1685,7 +1685,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.DeliveryApi(api_client)
 settle = 'usdt' # str | Settle currency
-futures_price_triggered_order = {"initial":{"contract":"BTC_USD","size":100,"price":"5.03","close":false,"tif":"gtc","text":"web"},"trigger":{"strategy_type":0,"price_type":0,"price":"3000","rule":1,"expiration":86400},"id":1283293,"user":1234,"create_time":1514764800,"finish_time":1514764900,"trade_id":13566,"status":"finished","finish_as":"cancelled","reason":""} # FuturesPriceTriggeredOrder | 
+futures_price_triggered_order = gate_api.FuturesPriceTriggeredOrder() # FuturesPriceTriggeredOrder | 
 
 try:
     # Create a price-triggered order

README.md

@@ -5,7 +5,7 @@ Futures contract details
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **str** | Futures contract | [optional] 
-**underling** | **str** | Underlying | [optional] 
+**underlying** | **str** | Underlying | [optional] 
 **cycle** | **str** | Cycle type, e.g. WEEKLY, QUARTERLY | [optional] 
 **type** | **str** | Futures contract type | [optional] 
 **quanto_multiplier** | **str** | Multiplier used in converting from invoicing to settlement currency in quanto futures | [optional] 

docs/DeliveryApi.md

@@ -1110,7 +1110,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.FuturesApi(api_client)
 settle = 'btc' # str | Settle currency (default to 'btc')
-futures_order = {"id":15675394,"user":100000,"contract":"BTC_USD","create_time":1546569968,"size":6024,"iceberg":0,"left":6024,"price":"3765","fill_price":"0","mkfr":"-0.00025","tkfr":"0.00075","tif":"gtc","refu":0,"is_reduce_only":false,"is_close":false,"is_liq":false,"text":"t-my-custom-id","status":"finished","finish_time":1514764900,"finish_as":"cancelled"} # FuturesOrder | 
+futures_order = gate_api.FuturesOrder() # FuturesOrder | 
 
 try:
     # Create a futures order
@@ -1674,7 +1674,7 @@ api_client = gate_api.ApiClient(configuration)
 # Create an instance of the API class
 api_instance = gate_api.FuturesApi(api_client)
 settle = 'btc' # str | Settle currency (default to 'btc')
-futures_price_triggered_order = {"initial":{"contract":"BTC_USD","size":100,"price":"5.03","close":false,"tif":"gtc","text":"web"},"trigger":{"strategy_type":0,"price_type":0,"price":"3000","rule":1,"expiration":86400},"id":1283293,"user":1234,"create_time":1514764800,"finish_time":1514764900,"trade_id":13566,"status":"finished","finish_as":"cancelled","reason":""} # FuturesPriceTriggeredOrder | 
+futures_price_triggered_order = gate_api.FuturesPriceTriggeredOrder() # FuturesPriceTriggeredOrder | 
 
 try:
     # Create a price-triggered order