spot orders support batch cancel; margin orders support auto borrow

revilwang · revilwang · commit 6bea15dcce9d · 2020-02-11T12:10:41.000+08:00
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@ 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.9.1
-- Package version: 4.9.1
+- API version: 4.10.0
+- Package version: 4.10.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
 
@@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
 *MarginApi* | [**repay_loan**](docs/MarginApi.md#repay_loan) | **POST** /margin/loans/{loan_id}/repayment | Repay a loan
 *MarginApi* | [**update_loan**](docs/MarginApi.md#update_loan) | **PATCH** /margin/loans/{loan_id} | Modify a loan
 *MarginApi* | [**update_loan_record**](docs/MarginApi.md#update_loan_record) | **PATCH** /margin/loan_records/{loan_record_id} | Modify a loan record
+*SpotApi* | [**cancel_batch_orders**](docs/SpotApi.md#cancel_batch_orders) | **POST** /spot/cancel_batch_orders | Cancel a batch of orders with an ID list
 *SpotApi* | [**cancel_order**](docs/SpotApi.md#cancel_order) | **DELETE** /spot/orders/{order_id} | Cancel a single order
 *SpotApi* | [**cancel_orders**](docs/SpotApi.md#cancel_orders) | **DELETE** /spot/orders | Cancel all &#x60;open&#x60; orders in specified currency pair
 *SpotApi* | [**create_batch_orders**](docs/SpotApi.md#create_batch_orders) | **POST** /spot/batch_orders | Create a batch of orders
@@ -156,6 +157,8 @@ Class | Method | HTTP request | Description
 ## Documentation For Models
 
  - [BatchOrder](docs/BatchOrder.md)
+ - [CancelOrder](docs/CancelOrder.md)
+ - [CancelOrderResult](docs/CancelOrderResult.md)
  - [Contract](docs/Contract.md)
  - [CurrencyPair](docs/CurrencyPair.md)
  - [FundingAccount](docs/FundingAccount.md)
diff --git a/docs/BatchOrder.md b/docs/BatchOrder.md
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **amount** | **str** | Trade amount | [optional] 
 **price** | **str** | Order price | [optional] 
 **time_in_force** | **str** | Time in force | [optional] [default to 'gtc']
+**auto_borrow** | **bool** | Used in margin trading(e.g. &#x60;account&#x60; is &#x60;margin&#x60;) to allow automatic loan of lacked part if balance is not enough. | [optional] 
 **left** | **str** | Amount left to fill | [optional] 
 **fill_price** | **str** | Fill price of the order | [optional] 
 **fee** | **str** | Fee deducted | [optional] 
diff --git a/docs/CancelOrder.md b/docs/CancelOrder.md
@@ -0,0 +1,11 @@
+# CancelOrder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_pair** | **str** | Order currency pair | 
+**id** | **str** | Order ID | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CancelOrderResult.md b/docs/CancelOrderResult.md
@@ -0,0 +1,14 @@
+# CancelOrderResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_pair** | **str** | Order currency pair | [optional] 
+**id** | **str** | Order ID | [optional] 
+**succeeded** | **bool** | Whether cancellation succeeded | [optional] 
+**label** | **str** | Error label when failed to cancel the order; emtpy if succeeded | [optional] 
+**message** | **str** | Error message when failed to cancel the order; empty if succeeded | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/Order.md b/docs/Order.md
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **amount** | **str** | Trade amount | 
 **price** | **str** | Order price | 
 **time_in_force** | **str** | Time in force | [optional] [default to 'gtc']
+**auto_borrow** | **bool** | Used in margin trading(e.g. &#x60;account&#x60; is &#x60;margin&#x60;) to allow automatic loan of lacked part if balance is not enough. | [optional] 
 **left** | **str** | Amount left to fill | [optional] 
 **fill_price** | **str** | Total filled in quote currency | [optional] 
 **fee** | **str** | Fee deducted | [optional] 
diff --git a/docs/SpotApi.md b/docs/SpotApi.md
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**cancel_batch_orders**](SpotApi.md#cancel_batch_orders) | **POST** /spot/cancel_batch_orders | Cancel a batch of orders with an ID list
 [**cancel_order**](SpotApi.md#cancel_order) | **DELETE** /spot/orders/{order_id} | Cancel a single order
 [**cancel_orders**](SpotApi.md#cancel_orders) | **DELETE** /spot/orders | Cancel all &#x60;open&#x60; orders in specified currency pair
 [**create_batch_orders**](SpotApi.md#create_batch_orders) | **POST** /spot/batch_orders | Create a batch of orders
@@ -20,6 +21,57 @@ Method | HTTP request | Description
 [**list_trades**](SpotApi.md#list_trades) | **GET** /spot/trades | Retrieve market trades
 
 
+# **cancel_batch_orders**
+> list[CancelOrderResult] cancel_batch_orders(cancel_order)
+
+Cancel a batch of orders with an ID list
+
+Multiple currency pairs can be specified, but maximum 20 orders are allowed per request
+
+### Example
+
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.rest import ApiException
+
+configuration = gate_api.Configuration()
+configuration.key = 'YOUR_API_KEY'
+configuration.secret = 'YOUR_API_SECRET'
+
+# create an instance of the API class
+api_instance = gate_api.SpotApi(gate_api.ApiClient(configuration))
+cancel_order = [gate_api.CancelOrder()] # list[CancelOrder] | 
+
+try:
+    # Cancel a batch of orders with an ID list
+    api_response = api_instance.cancel_batch_orders(cancel_order)
+    print(api_response)
+except ApiException as e:
+    print("Exception when calling SpotApi->cancel_batch_orders: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cancel_order** | [**list[CancelOrder]**](CancelOrder.md)|  | 
+
+### Return type
+
+[**list[CancelOrderResult]**](CancelOrderResult.md)
+
+### Authorization
+
+Authentication with API key and secret is required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **cancel_order**
 > Order cancel_order(order_id, currency_pair)
 
diff --git a/gate_api/__init__.py b/gate_api/__init__.py
@@ -14,7 +14,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "4.9.1"
+__version__ = "4.10.0"
 
 # import apis into sdk package
 from gate_api.api.futures_api import FuturesApi
@@ -27,6 +27,8 @@
 from gate_api.configuration import Configuration
 # import models into sdk package
 from gate_api.models.batch_order import BatchOrder
+from gate_api.models.cancel_order import CancelOrder
+from gate_api.models.cancel_order_result import CancelOrderResult
 from gate_api.models.contract import Contract
 from gate_api.models.currency_pair import CurrencyPair
 from gate_api.models.funding_account import FundingAccount
diff --git a/gate_api/api/spot_api.py b/gate_api/api/spot_api.py
@@ -32,6 +32,106 @@ def __init__(self, api_client=None):
             api_client = ApiClient()
         self.api_client = api_client
 
+    def cancel_batch_orders(self, cancel_order, **kwargs):  # noqa: E501
+        """Cancel a batch of orders with an ID list  # noqa: E501
+
+        Multiple currency pairs can be specified, but maximum 20 orders are allowed per request  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.cancel_batch_orders(cancel_order, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param list[CancelOrder] cancel_order: (required)
+        :return: list[CancelOrderResult]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.cancel_batch_orders_with_http_info(cancel_order, **kwargs)  # noqa: E501
+        else:
+            (data) = self.cancel_batch_orders_with_http_info(cancel_order, **kwargs)  # noqa: E501
+            return data
+
+    def cancel_batch_orders_with_http_info(self, cancel_order, **kwargs):  # noqa: E501
+        """Cancel a batch of orders with an ID list  # noqa: E501
+
+        Multiple currency pairs can be specified, but maximum 20 orders are allowed per request  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.cancel_batch_orders_with_http_info(cancel_order, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param list[CancelOrder] cancel_order: (required)
+        :return: list[CancelOrderResult]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = ['cancel_order']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method cancel_batch_orders" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'cancel_order' is set
+        if ('cancel_order' not in local_var_params or
+                local_var_params['cancel_order'] is None):
+            raise ValueError("Missing the required parameter `cancel_order` when calling `cancel_batch_orders`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'cancel_order' in local_var_params:
+            body_params = local_var_params['cancel_order']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['api_key', 'api_sign', 'api_timestamp']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/spot/cancel_batch_orders', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='list[CancelOrderResult]',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def cancel_order(self, order_id, currency_pair, **kwargs):  # noqa: E501
         """Cancel a single order  # noqa: E501
 
diff --git a/gate_api/api_client.py b/gate_api/api_client.py
@@ -75,7 +75,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/4.9.1/python'
+        self.user_agent = 'OpenAPI-Generator/4.10.0/python'
 
     def __del__(self):
         if self._pool:
diff --git a/gate_api/configuration.py b/gate_api/configuration.py
@@ -248,6 +248,6 @@ def to_debug_report(self):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 4.9.1\n"\
-               "SDK Package Version: 4.9.1".\
+               "Version of the API: 4.10.0\n"\
+               "SDK Package Version: 4.10.0".\
                format(env=sys.platform, pyversion=sys.version)
diff --git a/gate_api/models/__init__.py b/gate_api/models/__init__.py
@@ -15,6 +15,8 @@
 
 # import models into model package
 from gate_api.models.batch_order import BatchOrder
+from gate_api.models.cancel_order import CancelOrder
+from gate_api.models.cancel_order_result import CancelOrderResult
 from gate_api.models.contract import Contract
 from gate_api.models.currency_pair import CurrencyPair
 from gate_api.models.funding_account import FundingAccount
diff --git a/gate_api/models/batch_order.py b/gate_api/models/batch_order.py
@@ -46,6 +46,7 @@ class BatchOrder(object):
         'amount': 'str',
         'price': 'str',
         'time_in_force': 'str',
+        'auto_borrow': 'bool',
         'left': 'str',
         'fill_price': 'str',
         'fee': 'str',
@@ -70,6 +71,7 @@ class BatchOrder(object):
         'amount': 'amount',
         'price': 'price',
         'time_in_force': 'time_in_force',
+        'auto_borrow': 'auto_borrow',
         'left': 'left',
         'fill_price': 'fill_price',
         'fee': 'fee',
@@ -78,7 +80,7 @@ class BatchOrder(object):
         'gt_fee': 'gt_fee'
     }
 
-    def __init__(self, text=None, succeeded=None, label=None, message=None, id=None, create_time=None, update_time=None, status=None, currency_pair=None, type='limit', account='spot', side=None, amount=None, price=None, time_in_force='gtc', left=None, fill_price=None, fee=None, fee_currency=None, point_fee=None, gt_fee=None):  # noqa: E501
+    def __init__(self, text=None, succeeded=None, label=None, message=None, id=None, create_time=None, update_time=None, status=None, currency_pair=None, type='limit', account='spot', side=None, amount=None, price=None, time_in_force='gtc', auto_borrow=None, left=None, fill_price=None, fee=None, fee_currency=None, point_fee=None, gt_fee=None):  # noqa: E501
         """BatchOrder - a model defined in OpenAPI"""  # noqa: E501
 
         self._text = None
@@ -96,6 +98,7 @@ def __init__(self, text=None, succeeded=None, label=None, message=None, id=None,
         self._amount = None
         self._price = None
         self._time_in_force = None
+        self._auto_borrow = None
         self._left = None
         self._fill_price = None
         self._fee = None
@@ -134,6 +137,8 @@ def __init__(self, text=None, succeeded=None, label=None, message=None, id=None,
             self.price = price
         if time_in_force is not None:
             self.time_in_force = time_in_force
+        if auto_borrow is not None:
+            self.auto_borrow = auto_borrow
         if left is not None:
             self.left = left
         if fill_price is not None:
@@ -522,6 +527,29 @@ def time_in_force(self, time_in_force):
 
         self._time_in_force = time_in_force
 
+    @property
+    def auto_borrow(self):
+        """Gets the auto_borrow of this BatchOrder.  # noqa: E501
+
+        Used in margin trading(e.g. `account` is `margin`) to allow automatic loan of lacked part if balance is not enough.  # noqa: E501
+
+        :return: The auto_borrow of this BatchOrder.  # noqa: E501
+        :rtype: bool
+        """
+        return self._auto_borrow
+
+    @auto_borrow.setter
+    def auto_borrow(self, auto_borrow):
+        """Sets the auto_borrow of this BatchOrder.
+
+        Used in margin trading(e.g. `account` is `margin`) to allow automatic loan of lacked part if balance is not enough.  # noqa: E501
+
+        :param auto_borrow: The auto_borrow of this BatchOrder.  # noqa: E501
+        :type: bool
+        """
+
+        self._auto_borrow = auto_borrow
+
     @property
     def left(self):
         """Gets the left of this BatchOrder.  # noqa: E501
diff --git a/gate_api/models/cancel_order.py b/gate_api/models/cancel_order.py
diff --git a/gate_api/models/cancel_order_result.py b/gate_api/models/cancel_order_result.py
diff --git a/gate_api/models/order.py b/gate_api/models/order.py
diff --git a/setup.py b/setup.py
