Skip to content

Commit 137958f

Browse files
revilwangrevilwang
committed
fix invalid auto repay enum values
1 parent 55c40b3 commit 137958f

File tree

10 files changed

+241
-89
lines changed

10 files changed

+241
-89
lines changed

‎README.md‎

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## gate-api@4.20.0
1+
## gate-api@4.20.1
22

33
TypeScript NodeJS client for gate-api.
44

@@ -8,7 +8,7 @@ APIv4 provides spot, margin and futures trading operations. There are public API
88

99
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
1010

11-
- API version: 4.20.0
11+
- API version: 4.20.1
1212
- Package version:
1313
- Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen
1414
For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
@@ -49,45 +49,10 @@ If MAJOR version is incremented, make sure you read the release note on
4949
[Releases](https://github.com/gateio/gateapi-nodejs/releases)
5050
page
5151

52-
### Building
53-
54-
To build and compile the typescript sources to javascript use:
55-
```
56-
npm install
57-
npm run build
58-
```
59-
60-
### Consuming
61-
62-
#### Local development
63-
64-
To use the library locally, first install the dependencies by changing into the directory containing `package.json` (and this README). Then run:
65-
66-
```shell
67-
npm install
68-
```
69-
70-
Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following:
71-
72-
```shell
73-
npm link
74-
```
75-
76-
Finally, switch to the directory you want to use your gate-api from, and run:
77-
78-
```shell
79-
npm link gate-api
80-
```
81-
82-
You should now be able to `require('gate-api')` in javascript files from the directory you ran the last command above from.
83-
84-
#### git
85-
86-
If the library is hosted at a git repository, e.g. https://github.com/gateio/gateapi-nodejs
87-
then install it via:
52+
### Installation
8853

8954
```shell
90-
npm install gateio/gateapi-nodejs --save
55+
npm install gate-api
9156
```
9257

9358
## Getting Started

‎api/spotApi.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -855,7 +855,7 @@ export class SpotApi {
855855
* @summary Retrieve running auto order list
856856
* @param status List orders based on status
857857
* @param opts Optional parameters
858-
* @param opts.market 交易市场
858+
* @param opts.market Currency pair
859859
* @param opts.account Trading account
860860
* @param opts.limit Maximum number of records returned in one list
861861
* @param opts.offset List offset, starting from 0
@@ -958,7 +958,7 @@ export class SpotApi {
958958
*
959959
* @summary Cancel all open orders
960960
* @param opts Optional parameters
961-
* @param opts.market 交易市场
961+
* @param opts.market Currency pair
962962
* @param opts.account Trading account
963963
*/
964964
public async cancelSpotPriceTriggeredOrderList(opts: {

‎docs/AutoRepaySetting.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
88

99
## Enum: AutoRepaySetting.Status
1010

11-
* `True` (value: `'true'`)
11+
* `On` (value: `'on'`)
1212

13-
* `False` (value: `'false'`)
13+
* `Off` (value: `'off'`)
1414

1515

‎docs/CurrencyPair.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
1313
**amountPrecision** | **number** | Amount scale | [optional] [default to undefined]
1414
**precision** | **number** | Price scale | [optional] [default to undefined]
1515
**tradeStatus** | **string** | How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: can be bought or sold | [optional] [default to undefined]
16-
**sellStart** | **number** | 允许卖出时间，秒级 Unix 时间戳 | [optional] [default to undefined]
17-
**buyStart** | **number** | 允许买入时间，秒级 Unix 时间戳 | [optional] [default to undefined]
16+
**sellStart** | **number** | Sell start unix timestamp in seconds | [optional] [default to undefined]
17+
**buyStart** | **number** | Buy start unix timestamp in seconds | [optional] [default to undefined]
1818

1919
## Enum: CurrencyPair.TradeStatus
2020

‎docs/MarginApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -864,7 +864,7 @@ const client = new GateApi.ApiClient();
864864
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
865865

866866
const api = new GateApi.MarginApi(client);
867-
const status = "true"; // string | New auto repayment status. `on` - enabled, `off` - disabled
867+
const status = "on"; // string | New auto repayment status. `on` - enabled, `off` - disabled
868868
api.setAutoRepay(status)
869869
.then(value => console.log('API called successfully. Returned data: ', value.body),
870870
error => console.error(error));

‎docs/SpotApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -918,7 +918,7 @@ client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
918918
const api = new GateApi.SpotApi(client);
919919
const status = "status_example"; // 'open' | 'finished' | List orders based on status
920920
const opts = {
921-
'market': "BTC_USDT", // string | 交易市场
921+
'market': "BTC_USDT", // string | Currency pair
922922
'account': "account_example", // 'normal' | 'margin' | Trading account
923923
'limit': 100, // number | Maximum number of records returned in one list
924924
'offset': 0 // number | List offset, starting from 0
@@ -934,7 +934,7 @@ api.listSpotPriceTriggeredOrders(status, opts)
934934
Name | Type | Description | Notes
935935
------------- | ------------- | ------------- | -------------
936936
**status** | **Status**| List orders based on status | [default to undefined]
937-
**market** | **string**| 交易市场 | [optional] [default to undefined]
937+
**market** | **string**| Currency pair | [optional] [default to undefined]
938938
**account** | **Account**| Trading account | [optional] [default to undefined]
939939
**limit** | **number**| Maximum number of records returned in one list | [optional] [default to 100]
940940
**offset** | **number**| List offset, starting from 0 | [optional] [default to 0]
@@ -1013,7 +1013,7 @@ client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
10131013

10141014
const api = new GateApi.SpotApi(client);
10151015
const opts = {
1016-
'market': "BTC_USDT", // string | 交易市场
1016+
'market': "BTC_USDT", // string | Currency pair
10171017
'account': "account_example" // 'normal' | 'margin' | Trading account
10181018
};
10191019
api.cancelSpotPriceTriggeredOrderList(opts)
@@ -1026,7 +1026,7 @@ api.cancelSpotPriceTriggeredOrderList(opts)
10261026

10271027
Name | Type | Description | Notes
10281028
------------- | ------------- | ------------- | -------------
1029-
**market** | **string**| 交易市场 | [optional] [default to undefined]
1029+
**market** | **string**| Currency pair | [optional] [default to undefined]
10301030
**account** | **Account**| Trading account | [optional] [default to undefined]
10311031

10321032
### Return type

‎model/autoRepaySetting.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export class AutoRepaySetting {
3232

3333
export namespace AutoRepaySetting {
3434
export enum Status {
35-
True = <any>'true',
36-
False = <any>'false',
35+
On = <any>'on',
36+
Off = <any>'off',
3737
}
3838
}

‎model/currencyPair.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ export class CurrencyPair {
5050
*/
5151
'tradeStatus'?: CurrencyPair.TradeStatus;
5252
/**
53-
* 允许卖出时间，秒级 Unix 时间戳
53+
* Sell start unix timestamp in seconds
5454
*/
5555
'sellStart'?: number;
5656
/**
57-
* 允许买入时间，秒级 Unix 时间戳
57+
* Buy start unix timestamp in seconds
5858
*/
5959
'buyStart'?: number;
6060

0 commit comments

Comments
 (0)